home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 April / EnigmA AMIGA RUN 17 (1997)(G.R. Edizioni)(IT)[!][issue 1997-04][EAR-CD].iso / EARCD / comm / fido / Reflex10.lha / Reflex / Reflex.ARexx.doc < prev    next >
Text File  |  1996-11-17  |  149KB  |  4,872 lines
  1. TABLE OF CONTENTS
  2.  
  3. Reflex/--background--
  4. Reflex/AddPart
  5. Reflex/Attach
  6. Reflex/ChangeEntryAddress
  7. Reflex/ChangeEntryStatus
  8. Reflex/CheckAddress
  9. Reflex/ClipEntry
  10. Reflex/ClipList
  11. Reflex/CloseProgress
  12. Reflex/CopyEntry
  13. Reflex/CopyList
  14. Reflex/DeleteEntry
  15. Reflex/EditARexx
  16. Reflex/EditAttaching
  17. Reflex/EditDeletion
  18. Reflex/EditFiles
  19. Reflex/EditGeneral
  20. Reflex/EditGUI
  21. Reflex/EditMailer
  22. Reflex/EditNodebook
  23. Reflex/FindNextNode
  24. Reflex/FindNode
  25. Reflex/FirstEmpty
  26. Reflex/FirstEntry
  27. Reflex/FirstNode
  28. Reflex/FirstOrphan
  29. Reflex/FormatPollcommand
  30. Reflex/Freq
  31. Reflex/GetARexxDir
  32. Reflex/GetAttachDir
  33. Reflex/GetEntryAddress
  34. Reflex/GetEntryDate
  35. Reflex/GetEntryFilename
  36. Reflex/GetEntryFlowfile
  37. Reflex/GetEntryNum
  38. Reflex/GetEntrySize
  39. Reflex/GetEntryStatus
  40. Reflex/GetEntrySystem
  41. Reflex/GetEntryType
  42. Reflex/GetFlowEntry
  43. Reflex/GetLogfile
  44. Reflex/GetNodelist
  45. Reflex/GetNumEntries
  46. Reflex/GetOutbound
  47. Reflex/GetPollcommand
  48. Reflex/GetPollpattern
  49. Reflex/GetPort
  50. Reflex/GetPubscreen
  51. Reflex/GetReflexAuthor
  52. Reflex/GetReflexDate
  53. Reflex/GetReflexDesc
  54. Reflex/GetReflexName
  55. Reflex/GetReflexRelease
  56. Reflex/GetReflexVersion
  57. Reflex/HideGUI
  58. Reflex/IsCfgChanged
  59. Reflex/IsEmpty
  60. Reflex/IsFlowFile
  61. Reflex/IsFlowMail
  62. Reflex/IsFlowPkt
  63. Reflex/IsFreq
  64. Reflex/IsGUI
  65. Reflex/IsMissing
  66. Reflex/IsNode
  67. Reflex/IsOrphan
  68. Reflex/IsPkt
  69. Reflex/IsRegistered
  70. Reflex/IsReq
  71. Reflex/LastEntry
  72. Reflex/LockARexx
  73. Reflex/LockGUI
  74. Reflex/Maintenance
  75. Reflex/MatchAddress
  76. Reflex/MatchPollpattern
  77. Reflex/NB_GetNumNodes
  78. Reflex/NB_IsNode
  79. Reflex/NB_NodeReq
  80. Reflex/NB_Options
  81. Reflex/NB_Phone
  82. Reflex/NB_Poll
  83. Reflex/NB_Port
  84. Reflex/NB_PreventCall
  85. Reflex/NextEntry
  86. Reflex/NextNode
  87. Reflex/NextNodeEntry
  88. Reflex/OpenProgress
  89. Reflex/Poll
  90. Reflex/PollEntry
  91. Reflex/PrevEntry
  92. Reflex/PrevNode
  93. Reflex/PrevNodeEntry
  94. Reflex/PrintList
  95. Reflex/QueryOwnership
  96. Reflex/Quit
  97. Reflex/RequestAddress
  98. Reflex/RequestAttach
  99. Reflex/RequestFile
  100. Reflex/RequestFreq
  101. Reflex/RequestNode
  102. Reflex/RequestNotify
  103. Reflex/RequestPath
  104. Reflex/RequestResponse
  105. Reflex/RequestStatus
  106. Reflex/Rescan
  107. Reflex/SaveSettings
  108. Reflex/SetEntryAddress
  109. Reflex/SetEntryStatus
  110. Reflex/ShowAbout
  111. Reflex/ShowAcknowledgement
  112. Reflex/ShowGUI
  113. Reflex/ShowInfo
  114. Reflex/SortOutboundList
  115. Reflex/UnlockARexx
  116. Reflex/UnlockGUI
  117. Reflex/UpdateProgress
  118. Reflex/WriteLog
  119. Reflex/--background--                                Reflex/--background--
  120.  
  121.     COPYRIGHT
  122.         Reflex, Reflex.guide, Reflex.ARexx.doc and other accompanying
  123.         files are copyright Uffe Holst Christiansen unless otherwise
  124.         stated. Included runtime libraries are copyright their respective
  125.         authors.
  126.  
  127.         Reflex is shareware. Please read Reflex.guide for more information
  128.         about registering.
  129.  
  130.         Please send comments, bug reports, incorrect ARexx documentation,
  131.         suggestions, and registrations to:
  132.  
  133.             Uffe Holst Christiansen
  134.             c/o Christiansen
  135.             Strandgaards Alle 11
  136.             DK 3600 Frederikssund
  137.             Denmark
  138.  
  139.     PURPOSE
  140.         The purpose of the ARexx port is to make available a powerful
  141.         interface to the users. An interface to the features and
  142.         possibilities that Reflex offers.
  143.  
  144.         With over 100 ARexx commands most needs should be fulfilled. Alas
  145.         so many ARexx commands requires a bit of documentation, and this
  146.         documentation is what you're reading right now.
  147.  
  148.         Using the ARexx port gives you the possibility of tailoring Reflex
  149.         to your system and needs and performing the specific tasks you
  150.         like Reflex to perform unattended.
  151.  
  152.         Reflex has got a very important feature and that is ARexx locking.
  153.         ARexx locking means you lock the ARexx port so only your script
  154.         can access the port. Two ARexx scripts being executed at the same
  155.         time could cause some nasty consequences - ARexx locking prevents
  156.         this. ARexx locking should be used by all scripts. Please read the
  157.         'OWNERSHIP' section below and the commands associated with ARexx
  158.         locking.
  159.  
  160.     DISCLAIMER
  161.         My knowledge of ARexx programming is very little. Luckily it does
  162.         not prevent me form implementing an ARexx port in Reflex. Alas
  163.         I have to write documentation for the commands made available
  164.         through Reflex' ARexx port.
  165.  
  166.         I haven't tested the ARexx port a lot, because ARexx programming
  167.         bores me. Luckily my betatesters have done a better job in this
  168.         area than I have.
  169.  
  170.         I've never understood where to use single and where to use double
  171.         quotes in ARexx. I've also had a bit of trouble with EasyREXX and
  172.         strings containing spaces, but this might very well be because I
  173.         don't know enough about ARexx. If it is a problem with EasyREXX
  174.         then see the example under the autodoc entry for OpenProgress -
  175.         this works well.
  176.  
  177.         Apropro example. Since ARexx programming bores me it is with
  178.         regret I have to tell that this ARexx documentation contains very
  179.         few examples.
  180.  
  181.         I will not guarantee that the return codes actually are as stated
  182.         in the documentation, but I have made every possible attempt to
  183.         make them correct. Please report errors in the ARexx documentation
  184.         to the address above.
  185.  
  186.         Use Reflex and its ARexx port at your own risk.
  187.  
  188.         Thanks to my betatesters, Alex Holst, Anders Wegge Jakobsen and
  189.         Peter Kærsaa, for testing the ARexx port.
  190.  
  191.     PORTNAME
  192.         Reflex' ARexx port is named 'REFLEX'. Please notice it is spelled
  193.         with uppercase letters as the Amiga User Interface Style Guide
  194.         prescribes.
  195.  
  196.     AREXX SCRIPT SUFFIX
  197.         All ARexx scripts for Reflex ought to have the ending '#?.flex'.
  198.  
  199.     OVERVIEW
  200.         The ARexx commands covers all aspects of Reflex and in the
  201.         documentation they are sorted alphabetically. This is both good
  202.         and bad. Good because you easily can find the documentation for a
  203.         certain ARexx command; and bad because similar commands are spread
  204.         across the documentation.
  205.  
  206.         The ARexx commands are documented in a autodoc fashion. The
  207.         different sections in each autodoc entry is shortly described
  208.         below in the 'AUTODOC' section.
  209.  
  210.         To enhance the overview of the ARexx commands, the commands are
  211.         sorted in different groups below in the 'COMMAND GROUPS' section.
  212.         Each group contains commands associated with a certain aspect of
  213.         Reflex or Reflex ARexx programming.
  214.  
  215.     EASYREXX
  216.         Reflex uses the EasyREXX interface for its ARexx port. The
  217.         EasyREXX interface is a runtime shared library (easyrexx.library)
  218.         which you must have in you libs: directory.
  219.  
  220.         The easyrexx.library is included in the Reflex distribution.
  221.  
  222.         The easyrexx.library lets developers very easily add an ARexx port
  223.         to their program. Handling of ARexx is very easy using EasyREXX.
  224.         EasyREXX is highly recommendable for programmers.
  225.  
  226.         EasyREXX is copyright Ketil Hunn. Thanks to Ketil for making the
  227.         EasyREXX interface.
  228.  
  229.     AUTODOC
  230.         The documentation of the ARexx commands are done in an autodoc
  231.         fashion - just like functions in shared libraries are. Each ARexx
  232.         command has got an autodoc entry. The commands are sorted
  233.         alphabetically in the documentation.
  234.  
  235.         Each autodoc entry contains several sections which are shortly
  236.         described here.
  237.  
  238.         The 'NAME' section lists the name of the ARexx command and a
  239.         short description of the purpose of the command.
  240.  
  241.         The 'SYNOPSIS' section lists the syntax of the command. This
  242.         is here you see which arguments the command takes. The arguments
  243.         are listed like command line options, i.e. the modifiers used by
  244.         the Reflex ARexx commands are:
  245.  
  246.             /A - this is a required argument. This must be specified for
  247.                  EasyREXX to pass the command on to Reflex.
  248.             /K - this is a keyword argument. The keyword have to be
  249.                  specified in front of the option, i.e. "TITLE/K" means
  250.                  you would have to write 'title "Window title"'.
  251.             /S - this a switch. This a boolean variable and will be set
  252.                  if you specify it.
  253.             /N - this is a integer number.
  254.  
  255.         Arguments with no socalled modifiers will be filled if there is
  256.         arguments left, when the processing is done. Please notice, that
  257.         multiple modifiers can be specified; i.e. /N/A means a integer
  258.         number is a required argument.
  259.  
  260.         The 'FUNCTION' section is a long description of the purpose and
  261.         function of the ARexx command. Some commands are simple and do
  262.         only contain a brief description - other commands are more complex
  263.         or otherwise needs a more intensive description.
  264.  
  265.         The 'INPUTS' section lists the arguments the ARexx commands takes
  266.         and describes what they mean in a more intensive way as the
  267.         'FUNCTION' section did.
  268.  
  269.         The 'RETURN CODE' section lists what return codes the command
  270.         returns. The return code naturally depends upon what happened when
  271.         the command was received by Reflex. These return codes are
  272.         obtained in the ARexx RC variable.
  273.  
  274.         The 'RESULT' section lists what information is returned in the
  275.         RESULT variable if such information is returned. Remember to turn
  276.         this feature on by using 'Options results'.
  277.  
  278.         The 'BUGS' section describes bugs and misfeatures with the command
  279.         - luckily only a few commands have got anything listed here.
  280.  
  281.         The 'NOTE' section only available for a few commands gives some
  282.         more information - normally of less importance.
  283.  
  284.         The 'SEE ALSO' section tells you which other ARexx commands are
  285.         associated in function with the ARexx command.
  286.  
  287.     COMMAND GROUPS
  288.         To enhance the overview of the ARexx commands they are divided
  289.         into groups below according to their function. Notice some
  290.         commands might be listed in more than one group if their function
  291.         falls into the sphere of the certain group.
  292.  
  293.         'PROTECTION' commands
  294.         ---------------------
  295.           These commands are used to protect the script from interference
  296.           from the user and other ARexx scripts. This is called GUI and
  297.           ARexx locking. Regarding ARexx locking please refer to the
  298.           'OWNERSHIP' section below for more information about ARexx
  299.           locking.
  300.  
  301.           Commands used to handle GUI locking are:
  302.  
  303.                 LockGUI
  304.                 UnlockGUI
  305.  
  306.           and ARexx locking is handled by:
  307.  
  308.                 LockARexx
  309.                 QueryOwnership
  310.                 UnlockARexx
  311.  
  312.           It is important to match both LockGUI and LockARexx with the
  313.           respecitive unlock command before the script ends.
  314.  
  315.         'SEARCH and MOVE' commands
  316.         --------------------------
  317.           The outbound list contains all the entries listed in the main
  318.           window listview. The entry in the outbound list that the
  319.           outbound list pointer points to is called the 'current entry'.
  320.  
  321.           The commands in this group are used to move the outbound list
  322.           pointer to another entry in the outbound list.
  323.  
  324.           Commands used to search and move the outbound list pointer to
  325.           the first entry of a certain node:
  326.  
  327.                 FindNextNode
  328.                 FindNode
  329.  
  330.           Commands used to place the outbound list pointer at a position
  331.           respective to the current entry or the start or end of the
  332.           outbound list:
  333.  
  334.                 FirstEntry
  335.                 LastEntry
  336.                 NextEntry
  337.                 PrevEntry
  338.  
  339.           Commands used to move the outbound list pointer to a certain
  340.           type of file - for some of the commands respective to the
  341.           current entry:
  342.  
  343.                 FirstEmpty
  344.                 FirstNode
  345.                 FirstOrphan
  346.                 NextNode
  347.                 NextNodeEntry
  348.                 PrevNode
  349.                 PrevNodeEntry
  350.  
  351.           If such a 'Search and move' command fails the outbound list
  352.           pointer will not have moved; i.e. it points to the same entry as
  353.           it did before the command was executed.
  354.  
  355.         'OUTBOUND LIST' commands
  356.         ------------------------
  357.           This group contains a variety of commands that obtain
  358.           information about the outbound list and especially about the
  359.           current entry in the outbound list. Other commands are used to
  360.           check if a certain kind of entry exists in the outbound list.
  361.           Yet other commands are used to perform actions with respect to
  362.           the current entry and other change the current entry.
  363.  
  364.           Command used to obtain information about the outbound list:
  365.  
  366.                 GetNumEntries
  367.  
  368.           Commands used to obtain information about the current entry:
  369.  
  370.                 GetEntryAddress
  371.                 GetEntryDate
  372.                 GetEntryFilename
  373.                 GetEntryFlowfile
  374.                 GetEntryNum
  375.                 GetEntrySize
  376.                 GetEntryStatus
  377.                 GetEntrySystem
  378.                 GetEntryType
  379.                 GetFlowEntry
  380.  
  381.           The following commands are used to check if entries of a certain
  382.           kind exist in the outbound list:
  383.  
  384.                 IsEmpty
  385.                 IsFlowFile
  386.                 IsFlowMail
  387.                 IsFlowPkt
  388.                 IsFreq
  389.                 IsMissing
  390.                 IsNode
  391.                 IsOrphan
  392.                 IsPkt
  393.                 IsReq
  394.  
  395.           Commands that work on the current entry:
  396.  
  397.                 ClipEntry
  398.                 CopyEntry
  399.                 PollEntry
  400.                 ShowInfo
  401.  
  402.           And commands that change aspects of the current entry or even
  403.           remove the current entry from the outbound directory:
  404.  
  405.                 ChangeEntryAddress
  406.                 ChangeEntryStatus
  407.                 DeleteEntry
  408.                 SetEntryAddress
  409.                 SetEntryStatus
  410.  
  411.           Lastly commands that work on the full outbound list:
  412.  
  413.                 ClipList
  414.                 CopyList
  415.                 PrintList
  416.                 SortOutboundList
  417.  
  418.         'FIDO' commands
  419.         ---------------
  420.           This group of commands handles what I call Fido related aspects,
  421.           i.e. file requesting and attaching and handling of Fido
  422.           addresses:
  423.  
  424.                 Attach
  425.                 CheckAddress
  426.                 Freq
  427.                 MatchAddress
  428.  
  429.         'CONFIGURATION' commands
  430.         ------------------------
  431.           These commands concern different aspects of the configuration
  432.           of Reflex. Of most importance is the commands to obtain
  433.           configuration information:
  434.  
  435.                 GetARexxDir
  436.                 GetAttachDir
  437.                 GetLogfile
  438.                 GetNodelist
  439.                 GetOutbound
  440.                 GetPollcommand
  441.                 GetPollpattern
  442.                 GetPort
  443.  
  444.           These commands are used to invoke the configuration windows.
  445.           Personally I can't see that these can be of much use, but some
  446.           might find them usefull. Spot has got such commands too, so
  447.           why sholdn't I:
  448.  
  449.                 EditARexx
  450.                 EditAttaching
  451.                 EditDeletion
  452.                 EditFiles
  453.                 EditGeneral
  454.                 EditGUI
  455.                 EditMailer
  456.                 EditNodebook
  457.  
  458.           Other configuration commands:
  459.  
  460.                 IsCfgChanged
  461.                 SaveSettings
  462.  
  463.         'MAILER' commands
  464.         -----------------
  465.           The commands in this group concerns the interaction between
  466.           Reflex and you mailer. Most important is the two last commands
  467.           which executes the poll command:
  468.  
  469.                 EditMailer
  470.                 FormatPollcommand
  471.                 GetPollcommand
  472.                 GetPollpattern
  473.                 GetPort
  474.                 MatchPollpattern
  475.                 Poll
  476.                 PollEntry
  477.  
  478.         'GUI' commands
  479.         --------------
  480.           The commands of this group are used to control the graphic user
  481.           interface. Of most importance is the commands to open and close
  482.           the GUI:
  483.  
  484.                 EditGUI
  485.                 HideGUI
  486.                 IsGUI
  487.                 ShowGUI
  488.                 GetPubscreen
  489.  
  490.         'NODEBOOK' commands
  491.         -------------------
  492.           The Nodebook is the telephone book of Reflex. The commands of
  493.           this groups concerns the Nodebook:
  494.  
  495.                 EditNodebook
  496.                 NB_GetNumNodes
  497.                 NB_IsNode
  498.                 NB_NodeReq
  499.                 NB_Options
  500.                 NB_Phone
  501.                 NB_Poll
  502.                 NB_Port
  503.                 NB_PreventCall
  504.  
  505.         'REQUESTER' commands
  506.         --------------------
  507.           Reflex gives you certain commands for opening different
  508.           requesters. These are the commands you use to handle progress
  509.           requesters:
  510.  
  511.                 CloseProgress
  512.                 OpenProgress
  513.                 UpdateProgress
  514.  
  515.           File and path requesters, and requesters to notify the user or
  516.           give the user a choice:
  517.  
  518.                 RequestFile
  519.                 RequestNotify
  520.                 RequestPath
  521.                 RequestResponse
  522.  
  523.           Requesters to query a Fido address, a Fido address chosen from
  524.           a group of nodes, or to query a status:
  525.  
  526.                 RequestAddress
  527.                 RequestNode
  528.                 RequestStatus
  529.  
  530.           Commands to open the Attach or Freq requester:
  531.  
  532.                 RequestAttach
  533.                 RequestFreq
  534.  
  535.         'MISCELLANEOUS' commands:
  536.         -------------------------
  537.           This group consist of commands that doesn't fit into any of the
  538.           other groups very well. The first commands are used to perform
  539.           rescan or maintenances of the outbound directory:
  540.  
  541.                 Maintenance
  542.                 Rescan
  543.  
  544.           To write to the log file:
  545.  
  546.                 WriteLog
  547.  
  548.           Other commands:
  549.  
  550.                 AddPart
  551.                 IsRegistered
  552.                 Quit
  553.                 ShowAbout
  554.                 ShowAcknowledgement
  555.  
  556.         'USELESS' commands
  557.         ------------------
  558.           This group consist of useless commands:
  559.  
  560.                 GetReflexAuthor
  561.                 GetReflexDate
  562.                 GetReflexDesc
  563.                 GetReflexName
  564.                 GetReflexRelease
  565.                 GetReflexVersion
  566.  
  567.     OWNERSHIP
  568.         When you start an ARexx script you surely want everything to work
  569.         alright. The purpose of a script could be quite vital and it is
  570.         therefore of importance that nothing disturbs the script.
  571.  
  572.         One problem is that nothing prevents stupid users from interfering
  573.         by clicking the weirdest places in the GUI. This can be prevented
  574.         with the GUI locking feature of Reflex. The command LockGUI will
  575.         prevent the user from interfering while the script is running. A
  576.         LockGUI command must be matched with an UnlockGUI command before
  577.         the script ends.
  578.  
  579.         Another problem is other ARexx scripts. Absolutely nothing
  580.         prevents two ARexx scripts from addressing the ARexx port of an
  581.         application at the same time. This can naturally have quite fatal
  582.         consequences; just imagine one script places the outbound list
  583.         pointer on a certain entry with the purpose of deleting the entry.
  584.         In the meantime another scripts moves the outbound list pointer
  585.         to another entry with the result that this entry is deleted
  586.         instead of the entry destined for deletion.
  587.  
  588.         One ARexx script's interference with another ARexx script can in
  589.         Reflex be prevented with the ARexx locking feature of Reflex. When
  590.         Reflex is ARexx locked Reflex will only accept messages from the
  591.         script that locked the ARexx port; i.e. you have got the exclusive
  592.         usage of Reflex' ARexx port. All other messages are returned with
  593.         a return code of 20 (RC_FATAL).
  594.  
  595.             When the ARexx port is ARexx locked all commands sent to
  596.             the ARexx port are returned with an return code of 20
  597.             (RC_FATAL) unless the commands come from the script that
  598.             currently owns the ARexx port.
  599.  
  600.         It is vital that the LockARexx command is matched with an
  601.         UnlockARexx command before the script ends. Only the locking
  602.         script can unlock the ARexx port. If your script for some reason
  603.         ends before you unlocked the ARexx port it is impossible to unlock
  604.         it again and a reboot is necessary.
  605.  
  606.         All scripts for Reflex ought to use both GUI and ARexx locking.
  607.         Generally you will ARexx lock it before GUI locking it and GUI
  608.         unlock it before ARexx unlocking it. If you do not use ARexx
  609.         locking you might experience that another ARexx script steals
  610.         the ARexx port right from under you feet by using ARexx locking
  611.         which result in all commands in you script returning 20
  612.         (RC_FATAL).
  613.  
  614.         Actually the command LockARexx is superfluous and QueryOwnership
  615.         should be used instead. QueryOwnership will report whether or not
  616.         the ARexx port is locked. When QueryOwnership reports that the
  617.         ARexx port is locked you should do one of two:
  618.  
  619.         1. Exit your script.
  620.  
  621.         2. You would have put QueryOwnership in a loop and when it is
  622.            reported that the ARexx port is locked you wait a few seconds
  623.            and again query whether or not the port still is locked. It
  624.            will be up to you how many times you will continue to query
  625.            until you exit the script.
  626.  
  627.         If QueryOwnership reports that the ARexx port is free there is no
  628.         guarantee that the ARexx port still is free when you immediately
  629.         afterwards send the port a LockARexx command. Another script could
  630.         have locked the ARexx port in between.
  631.  
  632.         Therefore you will not use LockARexx to lock the ARexx port when
  633.         it is free. The QueryOwnership command has got a LOCK switch which
  634.         when stated automatically will lock the ARexx port if it was free.
  635.         You will now own the ARexx port and must remember to match the
  636.         QueryOwnership LOCK command with a UnlockARexx command.
  637.  
  638.         Use of ARexx 'onerror' is highly recommended. When Reflex is ARexx
  639.         locked nobody but the locking script will be able to unlock the
  640.         ARexx port. Therefore it is of vital importance that you correctly
  641.         handles errors and make sure to unlock the ARexx port before the
  642.         script ends.
  643.  
  644.         The following example shows how you should implement ARexx and GUI
  645.         locking in your own ARexx scripts for Reflex. The example is
  646.         available in the rexx directory as 'Skeleton.flex'.
  647.  
  648.         /* Skeleton.flex
  649.          * $VER: Skeleton.flex 1.2 (2.6.96)
  650.          *
  651.          * This script shows how to use ARexx and GUI locking in your
  652.          * own scripts. You ought to use Skeleton.flex or similar code
  653.          * when writing your own scripts
  654.          */
  655.  
  656.         SIGNAL ON FAILURE
  657.         OPTIONS FAILAT 20
  658.  
  659.         /* Initialization goes here
  660.          * Retries   - how many retries
  661.          * WaitDelay - how many ticks to wait between each retry
  662.          *             50 ticks = 1 second
  663.          */
  664.  
  665.         Retries = 25   
  666.         WaitDelay = 50
  667.  
  668.         ADDRESS 'REFLEX'
  669.         OPTIONS RESULTS
  670.  
  671.         OwnerShip = 0
  672.  
  673.         /*
  674.          * rexxsupport.library needed for delay
  675.          */
  676.  
  677.         IF (~SHOW('L',"rexxsupport.library")) THEN DO
  678.             IF (~ADDLIB("rexxsupport.library",0,-30,0)) THEN DO
  679.                 SAY '* Terminating; need rexxsupport.library'
  680.                 EXIT 10
  681.             END
  682.         END
  683.  
  684.         /*
  685.          * Attempt to lock the Arexx interface
  686.          * 'Retries' attempts are made; waiting 'WaitDelay'
  687.          * ticks between each attempt
  688.          */
  689.  
  690.         DO WHILE ((OwnerShip ~= 1) & (Retries > 0))
  691.             QUERYOWNERSHIP LOCK
  692.             Res = RC
  693.             IF (Res == 0) THEN
  694.                 OwnerShip = 1
  695.             ELSE
  696.                 CALL DELAY(WaitDelay)
  697.             Retries = Retries - 1
  698.         END
  699.  
  700.         IF (OwnerShip == 1) THEN DO 
  701.             LOCKGUI
  702.  
  703.             /* This is where you put your own
  704.              * possibly critical code - the ARexx
  705.              * port is for your use only
  706.              */
  707.  
  708.             UNLOCKGUI  
  709.             UNLOCKAREXX
  710.         END
  711.         EXIT 
  712.  
  713.         /*
  714.          * Handle errors
  715.          */
  716.  
  717.         Failure:
  718.             IF (OwnerShip == 1) THEN DO
  719.                 UNLOCKGUI
  720.                 UNLOCKAREXX
  721.             END
  722.         EXIT 10
  723.  
  724.         Well,   'Skeleton.flex'  is  courtesy  of  Anders  Wegge  Jakobsen.
  725.         'Skeleton.flex'  opens  'rexxsupport.library' to be able to use the
  726.         DELAY function.
  727.  
  728.     ERROR REQUESTERS
  729.         Reflex normally prompts you with error requesters if something
  730.         went wrong. Naturally error requesters will be very annoying when
  731.         an ARexx script is executed since Reflex will hang until you
  732.         come by and click 'Ok'.
  733.  
  734.         Therefore error requesters are suppressed when ARexx commands
  735.         are executed.
  736. Reflex/AddPart                                              Reflex/AddPart
  737.  
  738.     NAME
  739.         AddPart  --  appends a file/dir to the end of a path
  740.  
  741.     SYNOPSIS
  742.         AddPart DIR/A,FILE/A
  743.  
  744.     FUNCTION
  745.         This is to ease some of the problems you might meet when using
  746.         other Reflex commands. This is the Reflex ARexx interface to the
  747.         dos.library function AddPart().
  748.  
  749.         This command adds a file, directory, or subpath name to a
  750.         directory path name taking into account any required separator
  751.         characters. If filename is a fully-qualified path it will totally
  752.         replace the current value of dirname.
  753.  
  754.         The full filename incl. path is returned in RESULT.
  755.  
  756.     INPUTS
  757.         DIR/A  - the path to add a file/directory name to.
  758.         FILE/A - the filename or directory name to add. May be a relative
  759.                  pathname from the current directory (example: foo/bar).
  760.                  Can deal with leading '/'(s), indicating one directory up
  761.                  per '/', or with a ':', indicating it's relative to the
  762.                  root of the appropriate volume.
  763.  
  764.     RETURN CODE
  765.         0 (RC_OK)   - a filename incl. full path is returned in RESULT.
  766.         5 (RC_WARN) - something went wrong.
  767.  
  768.     RESULT
  769.         Full filename incl. path.
  770.  
  771.     BUGS
  772.         None known.
  773.  
  774.     NOTE
  775.         This autodoc entry for the ARexx command AddPart is to a great
  776.         extent a transcript from the dos.library autodoc's part about the
  777.         AddPart() function.
  778.  
  779.         This command is implemented because the paths specified in the
  780.         Files configuration might or might not have a '/' in the end.
  781.         Using the AddPart command means that you as a programmer do not
  782.         have to check for a '/' before adding a filename to a pathname.
  783.  
  784.     SEE ALSO
  785.         GetARexxDir, GetAttachDir, GetEntryFilename, GetLogFile,
  786.         GetNodelist, GetOutbound
  787. Reflex/Attach                                                Reflex/Attach
  788.  
  789.     NAME
  790.         Attach  --  attach a file
  791.  
  792.     SYNOPSIS
  793.         Attach FILE/A,TO/K/A,STATUS/K,ACTION/K,COPY/S,ATTACHDESC/S
  794.  
  795.     FUNCTION
  796.         This command attaches a file to another system. I did for example
  797.         use
  798.  
  799.             ATTACH 'MAIL:Files/Reflex.0.88.lha' TO '2:238/127'
  800.                                                 STATUS crash ACTION '^'
  801.  
  802.         when I back in version 0.88 tested the new Attach command by
  803.         attaching Reflex to my betatester.
  804.  
  805.         When you use the Attach command you should notice two things:
  806.  
  807.         - after this command has succeeded the outbound list will contain
  808.           one entry more than it did before. I.e. GetNumEntries will
  809.           return a number one larger.
  810.  
  811.         - the new entry (i.e. the new attached file) will be located at
  812.           the end of the list; i.e. it will be the last entry in the
  813.           outbound list. You can use SortOutboundList to sort the list and
  814.           thereby move the new entry to its correct position in the
  815.           outbound list if needed.
  816.  
  817.         Using the STATUS keyword you can specify the flavour the attach
  818.         should have. With the ACTION keyword you can specify the mailer
  819.         action.
  820.  
  821.         The COPY switch will instruct Reflex to copy the file to the
  822.         outbound directory before attaching the file. If Reflex for some
  823.         reason can't copy the file to the outbound directory it will be
  824.         attached from its home directory.
  825.  
  826.         The ATTACHDESC switch instructs Reflex to search for a description
  827.         file to attach along with the file itself. The description file is
  828.         found according to the settings in the Attaching requester.
  829.  
  830.     INPUTS
  831.         FILE/A       - filename incl. path of file to attach. The file
  832.                        does not have to exist. If it doesn't exist it will
  833.                        be marked as missing.
  834.         TO/K/A       - the Fido address of the system to receive the file.
  835.         STATUS/K     - flavour of file to attach; 'Normal', 'Crash',
  836.                        'Hold' or 'Direct'. Default to 'Normal' if not
  837.                        specified.
  838.         ACTION/K     - the mailer action, i.e. what should your mailer do
  839.                        with the file after it has been sent. Reflex
  840.                        doesn't check if the action you specify is known,
  841.                        but the mailer actions known by Reflex, TrapDoor
  842.                        etc. is:
  843.  
  844.                            # ... Truncate this file to zero length
  845.                            ^ ... Delete this file (with logging)
  846.                            - ... Delete this file (without logging)
  847.                            @ ... No special processing after sending (but
  848.                                  allow filenote tagging -- see below)
  849.                            ~ ... Don't send this file (has been sent
  850.                                  previously)
  851.  
  852.                        the only mailer "action' not mentioned above is 'No
  853.                        special processing' which occur when no character
  854.                        is put in front of the filename in the flow file.
  855.                        You can specify this action using a space (' ') -
  856.                        this is the default action if no action is
  857.                        specified.
  858.         COPY/S       - instruct Reflex to copy the file to the outbound
  859.                        directory before attaching.
  860.         ATTACHDESC/S - instruct Reflex to look for a description file to
  861.                        attach along with the file itself.
  862.  
  863.     RETURN CODE
  864.         0 (RC_OK)     - if the command succeeded fully and the file attach
  865.                         was made.
  866.         5 (RC_WARN)   - if an error occured while attaching the file.
  867.         10 (RC_ERROR) - if specified Fido address is invalid.
  868.         10 (RC_ERROR) - if specified status (flavour) is invalid.
  869.  
  870.     RESULT
  871.         None.
  872.  
  873.     BUGS
  874.         None known.
  875.  
  876.     NOTE
  877.         The mailer actions listed is a transcript from the documentation
  878.         for TrapDoor by Maximilian Hantsch and Martin Laubach.
  879.  
  880.     SEE ALSO
  881.         RequestAttach, SortOutboundList
  882. Reflex/ChangeEntryAddress                        Reflex/ChangeEntryAddress
  883.  
  884.     NAME
  885.         ChangeEntryAddress  --  request user for new address of current
  886.                                 entry
  887.  
  888.     SYNOPSIS
  889.         RESULT = ChangeEntryAddress
  890.  
  891.     FUNCTION
  892.         This command opens the Address requester to prompt the user for a
  893.         new Fido address for the current entry. The destination address of
  894.         the current entry will be changed. Naturally you can only change
  895.         address for an entry that already has an address.
  896.  
  897.         The Address requester will open with the address of the current
  898.         entry.
  899.  
  900.         The new Fido address for the current entry will be returned in
  901.         RESULT.
  902.  
  903.     INPUTS
  904.         None.
  905.  
  906.     RETURN CODE
  907.         0 (RC_OK)     - address was indeed changed. New address is
  908.                         available in RESULT.
  909.         5 (RC_WARN)   - for some reason Reflex didn't succeed in changing
  910.                         the address.
  911.         5 (RC_WARN)   - user cancelled Address requester.
  912.         10 (RC_ERROR) - current entry not of the right type, i.e. current
  913.                         entry is either an orphan or empty file.
  914.  
  915.     RESULT
  916.         The user selected new Fido address for the current entry.
  917.  
  918.     BUGS
  919.         None known.
  920.  
  921.     SEE ALSO
  922.         GetEntryAddress, RequestAddress, SetEntryAddress
  923. Reflex/ChangeEntryStatus                          Reflex/ChangeEntryStatus
  924.  
  925.     NAME
  926.         ChangeEntryStatus  --  request user for new status of current entry
  927.  
  928.     SYNOPSIS
  929.         RESULT = ChangeEntryStatus
  930.  
  931.     FUNCTION
  932.         This command opens the Status requester to prompt the user for a
  933.         new status (flavour) for the current entry. Naturally you can only
  934.         change status for entries with a Normal, Crash, Hold or Direct
  935.         flavour.
  936.  
  937.         The Status requester will open with the current flavour of the
  938.         current entry.
  939.  
  940.         You can also change status of requests at you system to normal
  941.         flow file entries using this command.
  942.  
  943.         The new status (flavour) for the current entry will be returned
  944.         in RESULT.
  945.  
  946.     INPUTS
  947.         None.
  948.  
  949.     RETURN CODE
  950.         0 (RC_OK)     - status was indeed changed. New status is available
  951.                         in RESULT.
  952.         5 (RC_WARN)   - for some reason Reflex didn't succeed in changing
  953.                         the status.
  954.         5 (RC_WARN)   - user cancelled Status requester.
  955.         10 (RC_ERROR) - current entry not of the right type, i.e. current
  956.                         entry is either a file request, orphan or empty
  957.                         file.
  958.  
  959.     RESULT
  960.         The user selected new status (flavour) for the current entry:
  961.  
  962.             "1" - Normal (flavour  is normal)
  963.             "2" - Crash  (flavour  is crash)
  964.             "3" - Hold   (flavour  is hold)
  965.             "4" - Direct (flavour  is direct)
  966.  
  967.     BUGS
  968.         None known.
  969.  
  970.     SEE ALSO
  971.         GetEntryStatus, RequestStatus, SetEntryStatus
  972. Reflex/CheckAddress                                    Reflex/CheckAddress
  973.  
  974.     NAME
  975.         CheckAddress  --  check if Fido address is valid.
  976.  
  977.     SYNOPSIS
  978.         CheckAddress ADDRESS/A
  979.  
  980.     FUNCTION
  981.         This command checks if a specified Fido address is valid.
  982.  
  983.         Valid Fido addresses are either 3D addresses (zone:net/node) or
  984.         4D addresses (zone:net/node.point), where zone, net, node and
  985.         point all are integers in the range 0 to 65535.
  986.  
  987.     INPUTS
  988.         ADDRESS/A - Fido address to check.
  989.  
  990.     RETURN CODE
  991.         0 (RC_OK)   - specified Fido address is valid.
  992.         5 (RC_WARN) - specified Fido address isn't valid.
  993.  
  994.     RESULT
  995.         None.
  996.  
  997.     BUGS
  998.         None known.
  999.  
  1000.     SEE ALSO
  1001. Reflex/ClipEntry                                          Reflex/ClipEntry
  1002.  
  1003.     NAME
  1004.         ClipEntry  --  copy current entry to clipboard
  1005.  
  1006.     SYNOPSIS
  1007.         ClipEntry
  1008.  
  1009.     FUNCTION
  1010.         This command copies the current entry to the clipboard. The
  1011.         copied entry is a line like the one displayed in the listview.
  1012.  
  1013.     INPUTS
  1014.         None.
  1015.  
  1016.     RETURN CODE
  1017.         0 (RC_OK) - is always returned.
  1018.  
  1019.     RESULT
  1020.         None.
  1021.  
  1022.     BUGS
  1023.         None known.
  1024.  
  1025.     SEE ALSO
  1026.         ClipList, CopyEntry, CopyList
  1027. Reflex/ClipList                                            Reflex/ClipList
  1028.  
  1029.     NAME
  1030.         ClipList  --  copy outbound list to clipboard
  1031.  
  1032.     SYNOPSIS
  1033.         ClipList
  1034.  
  1035.     FUNCTION
  1036.         This command copies the outbound list to the clipboard. The copied
  1037.         list is a serie of lines like the ones displayed in the listview.
  1038.  
  1039.     INPUTS
  1040.         None.
  1041.  
  1042.     RETURN CODE
  1043.         0 (RC_OK) - is always returned.
  1044.  
  1045.     RESULT
  1046.         None.
  1047.  
  1048.     BUGS
  1049.         None known.
  1050.  
  1051.     SEE ALSO
  1052.         ClipEntry, CopyEntry, CopyList
  1053. Reflex/CloseProgress                                  Reflex/CloseProgress
  1054.  
  1055.     NAME
  1056.         CloseProgress  --  close progress requester
  1057.  
  1058.     SYNOPSIS
  1059.         CloseProgress PROGRESS/N/A
  1060.  
  1061.     FUNCTION
  1062.         This function closes an opened progress requester.
  1063.  
  1064.         You will need a progress requester identifier key when you address
  1065.         the progress requester. You will have obtained this key when you
  1066.         opened the progress requester using the OpenProgress command.
  1067.  
  1068.     INPUTS
  1069.         PROGRESS/N/A - progress requester identifier key obtained from
  1070.                        OpenProgress. Specifying a zero key obtained from
  1071.                        OpenProgress when Reflex failed opening a progress
  1072.                        requester is allowed.
  1073.  
  1074.     RETURN CODE
  1075.         0 (RC_OK)   - if progress requester was closed.
  1076.         5 (RC_WARN) - progress requester identifier key was invalid (or
  1077.                       zero).
  1078.  
  1079.     RESULT
  1080.         None.
  1081.  
  1082.     BUGS
  1083.         None known.
  1084.  
  1085.     SEE ALSO
  1086.         OpenProgress, UpdateProgress
  1087. Reflex/CopyEntry                                          Reflex/CopyEntry
  1088.  
  1089.     NAME
  1090.         CopyEntry  --  copy current entry to clipboard
  1091.  
  1092.     SYNOPSIS
  1093.         CopyEntry
  1094.  
  1095.     FUNCTION
  1096.         This command copies the current entry to the clipboard. The
  1097.         copied entry is a line like the one displayed in the listview.
  1098.  
  1099.     INPUTS
  1100.         None.
  1101.  
  1102.     RETURN CODE
  1103.         0 (RC_OK) - is always returned.
  1104.  
  1105.     RESULT
  1106.         None.
  1107.  
  1108.     BUGS
  1109.         None known.
  1110.  
  1111.     SEE ALSO
  1112.         ClipEntry, ClipList, CopyList
  1113. Reflex/CopyList                                            Reflex/CopyList
  1114.  
  1115.     NAME
  1116.         CopyList  --  copy outbound list to clipboard
  1117.  
  1118.     SYNOPSIS
  1119.         CopyList
  1120.  
  1121.     FUNCTION
  1122.         This command copies the outbound list to the clipboard. The copied
  1123.         list is a serie of lines like the ones displayed in the listview.
  1124.  
  1125.     INPUTS
  1126.         None.
  1127.  
  1128.     RETURN CODE
  1129.         0 (RC_OK) - is always returned.
  1130.  
  1131.     RESULT
  1132.         None.
  1133.  
  1134.     BUGS
  1135.         None known.
  1136.  
  1137.     SEE ALSO
  1138.         ClipEntry, ClipList, CopyEntry
  1139. Reflex/DeleteEntry                                      Reflex/DeleteEntry
  1140.  
  1141.     NAME
  1142.         DeleteEntry  --  delete current entry
  1143.  
  1144.     SYNOPSIS
  1145.         DeleteEntry NOREQ/S
  1146.  
  1147.     FUNCTION
  1148.         This command deletes the current entry in the outbound list. In
  1149.         most cases Reflex will prompt you with a requester to confirm the
  1150.         deletion.
  1151.  
  1152.         If the current entry is an orphan or empty file, or if the current
  1153.         entry is a flow file entry of a missing file, Reflex will NOT
  1154.         prompt you with a requester before deleting the entry.
  1155.  
  1156.         Please notice, that the entry still exists in the outbound list
  1157.         after the deletion even though it actually was deleted. After the
  1158.         deletion the current entry will still be the same, i.e. the
  1159.         current entry is the deleted entry.
  1160.  
  1161.         Specifying the NOREQ switch will suppress the default confirmation
  1162.         requester and immediately delete the entry.
  1163.  
  1164.         The table below shows how Reflex handles the deletion with or
  1165.         without the NOREQ switch. [] means safety requesters; 'bundle',
  1166.         'mail' and 'file' are the actual files that are deleted; 'entry'
  1167.         is the flow file entry being removed (the file will not be
  1168.         deleted).
  1169.  
  1170.         Entry type                   DeleteEntry          DeleteEntry NOREQ
  1171.         -------------------------------------------------------------------
  1172.         Compr. mail bundles          [Delete y/n?]        Bundle deleted
  1173.         Uncompr. mail in flow files  [Delete y/n?]        Mail deleted
  1174.         File attaches                [Remove/delete/no?]  Entry removed
  1175.         Entries of missing files     Entry removed        Entry removed
  1176.         4D uncompr. mail packets     [Delete y/n?]        Mail deleted
  1177.         File requests                [Delete y/n?]        Freq deleted
  1178.         Orphan files                 File deleted         File deleted
  1179.         Empty files                  File deleted         File deleted
  1180.         Requests at your system      [Delete y/n?]        Entry removed
  1181.         -------------------------------------------------------------------
  1182.  
  1183.         The outbound list will not be updated before you perform a rescan
  1184.         of the outbound directory. Until then you might come across the
  1185.         deleted entry when you browse the outbound list.
  1186.  
  1187.     INPUTS
  1188.         None.
  1189.  
  1190.     RETURN CODE
  1191.         0 (RC_OK)   - if the entry was indeed deleted.
  1192.         5 (RC_WARN) - if the entry for some reason wasn't deleted.
  1193.  
  1194.     RESULT
  1195.         None.
  1196.  
  1197.     BUGS
  1198.         None known.
  1199.  
  1200.     SEE ALSO
  1201.         Rescan
  1202. Reflex/EditARexx                                          Reflex/EditARexx
  1203.  
  1204.     NAME
  1205.         EditARexx  --  open ARexx configuration
  1206.  
  1207.     SYNOPSIS
  1208.         EditARexx
  1209.  
  1210.     FUNCTION
  1211.         Opens the ARexx configuration window for the user to make changes
  1212.         in the configuration.
  1213.  
  1214.     INPUTS
  1215.         None.
  1216.  
  1217.     RETURN CODE
  1218.         0 (RC_OK)   - if no changes were made.
  1219.         5 (RC_WARN) - if changes were made.
  1220.  
  1221.     RESULT
  1222.         None.
  1223.  
  1224.     BUGS
  1225.         None known.
  1226.  
  1227.     SEE ALSO
  1228.         EditAttaching, EditDeletion, EditFiles, EditGeneral, EditGUI,
  1229.         EditMailer, EditNodebook, IsCfgChanged, SaveSettings
  1230. Reflex/EditAttaching                                  Reflex/EditAttaching
  1231.  
  1232.     NAME
  1233.         EditAttaching  --  open Attaching configuration
  1234.  
  1235.     SYNOPSIS
  1236.         EditAttaching
  1237.  
  1238.     FUNCTION
  1239.         Opens the Attaching configuration window for the user to make
  1240.         changes in the configuration.
  1241.  
  1242.     INPUTS
  1243.         None.
  1244.  
  1245.     RETURN CODE
  1246.         0 (RC_OK)   - if no changes were made.
  1247.         5 (RC_WARN) - if changes were made.
  1248.  
  1249.     RESULT
  1250.         None.
  1251.  
  1252.     BUGS
  1253.         None known.
  1254.  
  1255.     SEE ALSO
  1256.         EditARexx, EditDeletion, EditFiles, EditGeneral, EditGUI,
  1257.         EditMailer, EditNodebook, IsCfgChanged, SaveSettings
  1258. Reflex/EditDeletion                                    Reflex/EditDeletion
  1259.  
  1260.     NAME
  1261.         EditDeletion  --  open Deletion configuration
  1262.  
  1263.     SYNOPSIS
  1264.         EditDeletion
  1265.  
  1266.     FUNCTION
  1267.         Opens the Deletion configuration window for the user to make
  1268.         changes in the configuration.
  1269.  
  1270.     INPUTS
  1271.         None.
  1272.  
  1273.     RETURN CODE
  1274.         0 (RC_OK)   - if no changes were made.
  1275.         5 (RC_WARN) - if changes were made.
  1276.  
  1277.     RESULT
  1278.         None.
  1279.  
  1280.     BUGS
  1281.         None known.
  1282.  
  1283.     SEE ALSO
  1284.         EditARexx, EditAttaching, EditFiles, EditGeneral, EditGUI,
  1285.         EditMailer, EditNodebook, IsCfgChanged, SaveSettings
  1286. Reflex/EditFiles                                          Reflex/EditFiles
  1287.  
  1288.     NAME
  1289.         EditFiles  --  open Files configuration
  1290.  
  1291.     SYNOPSIS
  1292.         EditFiles
  1293.  
  1294.     FUNCTION
  1295.         Opens the Files configuration window for the user to make changes
  1296.         in the configuration.
  1297.  
  1298.     INPUTS
  1299.         None.
  1300.  
  1301.     RETURN CODE
  1302.         0 (RC_OK)   - if no changes were made.
  1303.         5 (RC_WARN) - if changes were made.
  1304.  
  1305.     RESULT
  1306.         None.
  1307.  
  1308.     BUGS
  1309.         None known.
  1310.  
  1311.     SEE ALSO
  1312.         EditARexx, EditAttaching, EditDeletion, EditGeneral, EditGUI,
  1313.         EditMailer, EditNodebook, IsCfgChanged, SaveSettings
  1314. Reflex/EditGeneral                                      Reflex/EditGeneral
  1315.  
  1316.     NAME
  1317.         EditGeneral  --  open General configuration
  1318.  
  1319.     SYNOPSIS
  1320.         EditGeneral
  1321.  
  1322.     FUNCTION
  1323.         Opens the General configuration window for the user to make
  1324.         changes in the configuration.
  1325.  
  1326.     INPUTS
  1327.         None.
  1328.  
  1329.     RETURN CODE
  1330.         0 (RC_OK)   - if no changes were made.
  1331.         5 (RC_WARN) - if changes were made.
  1332.  
  1333.     RESULT
  1334.         None.
  1335.  
  1336.     BUGS
  1337.         None known.
  1338.  
  1339.     SEE ALSO
  1340.         EditARexx, EditAttaching, EditDeletion, EditFiles, EditGUI,
  1341.         EditMailer, EditNodebook, IsCfgChanged, SaveSettings
  1342. Reflex/EditGUI                                              Reflex/EditGUI
  1343.  
  1344.     NAME
  1345.         EditGUI  --  open GUI configuration
  1346.  
  1347.     SYNOPSIS
  1348.         EditGUI
  1349.  
  1350.     FUNCTION
  1351.         Opens the GUI configuration window for the user to make
  1352.         changes in the configuration.
  1353.  
  1354.     INPUTS
  1355.         None.
  1356.  
  1357.     RETURN CODE
  1358.         0 (RC_OK)   - if no changes were made.
  1359.         5 (RC_WARN) - if changes were made.
  1360.  
  1361.     RESULT
  1362.         None.
  1363.  
  1364.     BUGS
  1365.         None known.
  1366.  
  1367.     SEE ALSO
  1368.         EditARexx, EditAttaching, EditDeletion, EditFiles, EditGeneral,
  1369.         EditMailer, EditNodebook, IsCfgChanged, SaveSettings
  1370. Reflex/EditMailer                                        Reflex/EditMailer
  1371.  
  1372.     NAME
  1373.         EditMailer  --  open Mailer configuration
  1374.  
  1375.     SYNOPSIS
  1376.         EditMailer
  1377.  
  1378.     FUNCTION
  1379.         Opens the Mailer configuration window for the user to make
  1380.         changes in the configuration.
  1381.  
  1382.     INPUTS
  1383.         None.
  1384.  
  1385.     RETURN CODE
  1386.         0 (RC_OK)   - if no changes were made.
  1387.         5 (RC_WARN) - if changes were made.
  1388.  
  1389.     RESULT
  1390.         None.
  1391.  
  1392.     BUGS
  1393.         None known.
  1394.  
  1395.     SEE ALSO
  1396.         EditARexx, EditAttaching, EditDeletion, EditFiles, EditGeneral,
  1397.         EditGUI, EditNodebook, IsCfgChanged, SaveSettings
  1398. Reflex/EditNodebook                                    Reflex/EditNodebook
  1399.  
  1400.     NAME
  1401.         EditNodebook  --  open Nodebook configuration
  1402.  
  1403.     SYNOPSIS
  1404.         EditNodebook
  1405.  
  1406.     FUNCTION
  1407.         Opens the Nodebook configuration window for the user to make
  1408.         changes in the configuration.
  1409.  
  1410.     INPUTS
  1411.         None.
  1412.  
  1413.     RETURN CODE
  1414.         0 (RC_OK)   - if no changes were made.
  1415.         5 (RC_WARN) - if changes were made.
  1416.  
  1417.     RESULT
  1418.         None.
  1419.  
  1420.     BUGS
  1421.         None known.
  1422.  
  1423.     SEE ALSO
  1424.         EditARexx, EditAttaching, EditDeletion, EditFiles, EditGeneral,
  1425.         EditGUI, EditMailer, IsCfgChanged, NB_GetNumNodes, NB_IsNode,
  1426.         NB_NodeReq, NB_Options, NB_Phone, NB_Poll, NB_Port,
  1427.         NB_PreventCall, SaveSettings
  1428. Reflex/FindNextNode                                    Reflex/FindNextNode
  1429.  
  1430.     NAME
  1431.         FindNextNode  --  find node from current entry and move outbound
  1432.                           list pointer
  1433.  
  1434.     SYNOPSIS
  1435.         FindNextNode NODE/A
  1436.  
  1437.     FUNCTION
  1438.         This command will attempt to locate a certain node in the outbound
  1439.         list. If the node is found the outbound list pointer will be moved
  1440.         to the first entry with the node.
  1441.  
  1442.         The search is conducted from current entry in the outbound list.
  1443.  
  1444.         This command currently requires traplist.library.
  1445.  
  1446.     INPUTS
  1447.         NODE/A - Fido address of node to look for in outbound list.
  1448.  
  1449.     RETURN CODE
  1450.         0 (RC_OK)     - if the node was located in the outbound list. The
  1451.                         outbound list pointer is moved to the first entry
  1452.                         with the node.
  1453.         5 (RC_WARN)   - if no entry in the outbound list matched the
  1454.                         specified node.
  1455.         10 (RC_ERROR) - traplist.library not available.
  1456.         10 (RC_ERROR) - specified Fido address invalid.
  1457.  
  1458.     RESULT
  1459.         None.
  1460.  
  1461.     BUGS
  1462.         None known.
  1463.  
  1464.     SEE ALSO
  1465.         FindNode, FirstEmpty, FirstEntry, FirstNode, FirstOrphan,
  1466.         LastEntry, NextEntry, NextNode, NextNodeEntry, PrevEntry,
  1467.         PrevNode, PrevNodeEntry
  1468. Reflex/FindNode                                            Reflex/FindNode
  1469.  
  1470.     NAME
  1471.         FindNode  --  find node and move outbound list pointer
  1472.  
  1473.     SYNOPSIS
  1474.         FindNode NODE/A
  1475.  
  1476.     FUNCTION
  1477.         This command will attempt to locate a certain node in the outbound
  1478.         list. If the node is found the outbound list pointer will be moved
  1479.         to the first entry with the node.
  1480.  
  1481.         The search is conducted from the beginning of the outbound list.
  1482.  
  1483.         This command currently requires traplist.library.
  1484.  
  1485.     INPUTS
  1486.         NODE/A - Fido address of node to look for in outbound list.
  1487.  
  1488.     RETURN CODE
  1489.         0 (RC_OK)     - if the node was located in the outbound list. The
  1490.                         outbound list pointer is moved to the first entry
  1491.                         with the node.
  1492.         5 (RC_WARN)   - if no entry in the outbound list matched the
  1493.                         specified node.
  1494.         10 (RC_ERROR) - traplist.library not available.
  1495.         10 (RC_ERROR) - specified Fido address invalid.
  1496.  
  1497.     RESULT
  1498.         None.
  1499.  
  1500.     BUGS
  1501.         None known.
  1502.  
  1503.     SEE ALSO
  1504.         FindNextNode, FirstEmpty, FirstEntry, FirstNode, FirstOrphan,
  1505.         IsNode, LastEntry, NextEntry, NextNode, NextNodeEntry, PrevEntry,
  1506.         PrevNode, PrevNodeEntry
  1507. Reflex/FirstEmpty                                        Reflex/FirstEmpty
  1508.  
  1509.     NAME
  1510.         FirstEmpty  --  move outbound list pointer to first empty file
  1511.  
  1512.     SYNOPSIS
  1513.         FirstEmpty
  1514.  
  1515.     FUNCTION
  1516.         This command will move the outbound list pointer to the first
  1517.         empty file in the outbound list.
  1518.  
  1519.         The commands NextNodeEntry and PrevNodeEntry can be used to move
  1520.         the outbound list pointer from one empty file to the next or
  1521.         previous empty file, respectively.
  1522.  
  1523.     INPUTS
  1524.         None.
  1525.  
  1526.     RETURN CODE
  1527.         0 (RC_OK)     - if the outbound list pointer was moved to the
  1528.                         first empty file.
  1529.         5 (RC_WARN)   - if the outbound list doesn't contain any empty
  1530.                         files.
  1531.         10 (RC_ERROR) - if the outbound list is empty.
  1532.  
  1533.     RESULT
  1534.         None.
  1535.  
  1536.     BUGS
  1537.         None known.
  1538.  
  1539.     SEE ALSO
  1540.         FindNextNode, FindNode, FirstEntry, FirstNode, FirstOrphan,
  1541.         LastEntry, NextEntry, NextNode, NextNodeEntry, PrevEntry,
  1542.         PrevNode, PrevNodeEntry
  1543. Reflex/FirstEntry                                        Reflex/FirstEntry
  1544.  
  1545.     NAME
  1546.         FirstEntry  -- move outbound list pointer to first entry
  1547.  
  1548.     SYNOPSIS
  1549.         FirstEntry
  1550.  
  1551.     FUNCTION
  1552.         This command moves the outbound list pointer to the first entry
  1553.         in the outbound list.
  1554.  
  1555.     INPUTS
  1556.         None.
  1557.  
  1558.     RETURN CODE
  1559.         0 (RC_OK)     - if the outbound list pointer was moved to the
  1560.                         first entry.
  1561.         10 (RC_ERROR) - if the outbound list is empty.
  1562.  
  1563.     RESULT
  1564.         None.
  1565.  
  1566.     BUGS
  1567.         None known.
  1568.  
  1569.     SEE ALSO
  1570.         FindNextNode, FindNode, FirstEmpty, FirstNode, FirstOrphan,
  1571.         LastEntry, NextEntry, NextNode, NextNodeEntry, PrevEntry,
  1572.         PrevNode, PrevNodeEntry
  1573. Reflex/FirstNode                                          Reflex/FirstNode
  1574.  
  1575.     NAME
  1576.         FirstNode  --  move outbound list pointer to first node entry
  1577.         
  1578.     SYNOPSIS
  1579.         FirstNode
  1580.  
  1581.     FUNCTION
  1582.         This command will move the outbound list pointer to the first
  1583.         entry in the outbound list with a Fido address. In practice this
  1584.         will move the outbound list pointer to the first entry - unless
  1585.         the first entry is an orphan or empty file.
  1586.  
  1587.     INPUTS
  1588.         None.
  1589.  
  1590.     RETURN CODE
  1591.         0 (RC_OK)     - is returned if the outbound list pointer was moved
  1592.                         to the first entry with a Fido address.
  1593.         5 (RC_WARN)   - if there isn't an entry in the outbound list with
  1594.                         a Fido address. The outbound list pointer will not
  1595.                         have moved.
  1596.         10 (RC_ERROR) - if the outbound list is empty.
  1597.  
  1598.     RESULT
  1599.         None.
  1600.  
  1601.     BUGS
  1602.         None known.
  1603.  
  1604.     SEE ALSO
  1605.         FindNextNode, FindNode, FirstEmpty, FirstEntry, FirstOrphan,
  1606.         LastEntry, NextEntry, NextNode, NextNodeEntry, PrevEntry,
  1607.         PrevNode, PrevNodeEntry
  1608. Reflex/FirstOrphan                                      Reflex/FirstOrphan
  1609.  
  1610.     NAME
  1611.         FirstOrphan  --  move outbound list pointer to first orphan file
  1612.  
  1613.     SYNOPSIS
  1614.         FirstOrphan
  1615.  
  1616.     FUNCTION
  1617.         This command will move the outbound list pointer to the first
  1618.         orphan file in the outbound list.
  1619.  
  1620.         The commands NextNodeEntry and PrevNodeEntry can be used to move
  1621.         the outbound list pointer from one orphan file to the next or
  1622.         previous orphan file, respectively.
  1623.  
  1624.     INPUTS
  1625.         None.
  1626.  
  1627.     RETURN CODE
  1628.         0 (RC_OK)     - if the outbound list pointer was moved to the
  1629.                         first orphan file.
  1630.         5 (RC_WARN)   - if the outbound list doesn't contain any orphan
  1631.                         files.
  1632.         10 (RC_ERROR) - if the outbound list is empty.
  1633.  
  1634.     RESULT
  1635.         None.
  1636.  
  1637.     BUGS
  1638.         None known.
  1639.  
  1640.     SEE ALSO
  1641.         FindNextNode, FindNode, FirstEmpty, FirstEntry, FirstNode,
  1642.         LastEntry, NextEntry, NextNode, NextNodeEntry, PrevEntry,
  1643.         PrevNode, PrevNodeEntry
  1644. Reflex/FormatPollcommand                          Reflex/FormatPollcommand
  1645.  
  1646.     NAME
  1647.         FormatPollcommmand  --  format poll command for a node
  1648.  
  1649.     SYNOPSIS
  1650.         RESULT = FormatPollcommand NODE/A,POLLCOMMAND/K
  1651.  
  1652.     FUNCTION
  1653.         This function returns a formatted poll command for a specified
  1654.         node. The poll command as specified in the Mailer configuration
  1655.         is formatted for the specified node according to the settings
  1656.         specified for the node in the Nodebook.
  1657.  
  1658.         Another poll command can be specified to be used instead of the
  1659.         one specified in the Mailer configuration for the formatting.
  1660.  
  1661.         The formatted poll command is returned in RESULT.
  1662.  
  1663.     INPUTS
  1664.         NODE/A        - Fido address of the node for whom to format the
  1665.                         poll command.
  1666.         POLLCOMMAND/K - another poll command to use instead of the one
  1667.                         specified in the Mailer configuration.
  1668.  
  1669.     RETURN CODE
  1670.         0 (RC_OK)     - if a formatted poll command is returned in RESULT.
  1671.         5 (RC_WARN)   - if Reflex for some reason didn't succeed in
  1672.                         formatting the poll command.
  1673.         10 (RC_ERROR) - if the specified Fido address is invalid.
  1674.  
  1675.     RESULT
  1676.         A formatted poll command for the specified node. For example if
  1677.         the poll command specified in the Mailer configuration is
  1678.         "TrapDoor CALL %n" and the node specified in the FormatPollcommand
  1679.         call is 2:238/127 Reflex will return "TrapDoor CALL 2:238/127".
  1680.  
  1681.         Please notice, that according to the settings in the Nodebook the
  1682.         node number might be substituted with another node number or a
  1683.         phone number.
  1684.  
  1685.     BUGS
  1686.         None known.
  1687.  
  1688.     SEE ALSO
  1689.         GetPollcommand, Poll, PollEntry
  1690. Reflex/Freq                                                    Reflex/Freq
  1691.  
  1692.     NAME
  1693.         Freq  --  file request a file
  1694.  
  1695.     SYNOPSIS
  1696.         Freq FILE/A,AT/K/A
  1697.  
  1698.     FUNCTION
  1699.         This command will request a file at another system. For example
  1700.         will
  1701.  
  1702.             FREQ REFLEX AT "2:238/127"
  1703.  
  1704.         make a file request for 'REFLEX' at 2:238/127. When you use the
  1705.         Freq command there is a couple of things to notice:
  1706.  
  1707.         - after this command has succeeded the outbound list will contain
  1708.           one entry more than it did before. I.e. GetNumEntries will
  1709.           return a number one larger.
  1710.  
  1711.         - the new entry (i.e. the new file request) will be located at the
  1712.           end of the list; i.e. it will be the last entry in the outbound
  1713.           list. You can use SortOutboundList to sort the list and thereby
  1714.           move the new entry to its correct position in the outbound list
  1715.           if needed.
  1716.  
  1717.     INPUTS
  1718.         FILE/A - name of file to request.
  1719.         AT/K   - system at which the request shall take place. This is a
  1720.                  Fido address.
  1721.  
  1722.     RETURN CODE
  1723.         0 (RC_OK)     - if the command succeeded fully and the file
  1724.                         request was made.
  1725.         5 (RC_WARN)   - if an error occured.
  1726.         10 (RC_ERROR) - if the specified Fido address is invalid.
  1727.  
  1728.     RESULT
  1729.         None.
  1730.  
  1731.     BUGS
  1732.         None known.
  1733.  
  1734.     SEE ALSO
  1735.         RequestAttach, SortOutboundList
  1736. Reflex/GetARexxDir                                      Reflex/GetARexxDir
  1737.  
  1738.     NAME
  1739.         GetARexxDir  --  obtain path to ARexx directory
  1740.  
  1741.     SYNOPSIS
  1742.         RESULT = GetARexxDir
  1743.  
  1744.     FUNCTION
  1745.         This command returns the path to the ARexx directory as specified
  1746.         in the Files configuration. The path is returned in RESULT. ARexx
  1747.         scripts are located in the ARexx directory.
  1748.  
  1749.     INPUTS
  1750.         None.
  1751.  
  1752.     RETURN CODE
  1753.         0 (RC_OK)     - when the path to the ARexx directory is returned
  1754.                         in RESULT.
  1755.         10 (RC_ERROR) - if no ARexx directory was specified.
  1756.  
  1757.     RESULT
  1758.         The ARexx directory, e.g. "REXX:Reflex"
  1759.  
  1760.     BUGS
  1761.         None known.
  1762.  
  1763.     SEE ALSO
  1764.         AddPart, GetAttachDir, GetEntryFilename, GetLogfile, GetNodelist,
  1765.         GetOutbound
  1766. Reflex/GetAttachDir                                    Reflex/GetAttachDir
  1767.  
  1768.     NAME
  1769.         GetAttachDir  --  obtain path to attach directory
  1770.  
  1771.     SYNOPSIS
  1772.         RESULT = GetAttachDir
  1773.  
  1774.     FUNCTION
  1775.         This command returns the path to the attach directory as specified
  1776.         in the Files configuration. The path is returned in RESULT. The
  1777.         attach directory is the directory the Attach requester will open
  1778.         its file requester in.
  1779.  
  1780.     INPUTS
  1781.         None.
  1782.  
  1783.     RETURN CODE
  1784.         0 (RC_OK)     - when the path to the attach directory is returned
  1785.                         in RESULT.
  1786.         10 (RC_ERROR) - if no attach directory was specified.
  1787.  
  1788.     RESULT
  1789.         The attach directory, e.g. "BBS:Files"
  1790.  
  1791.     BUGS
  1792.         None known.
  1793.  
  1794.     SEE ALSO
  1795.         AddPart, GetARexxDir, GetEntryFilename, GetLogfile, GetNodelist,
  1796.         GetOutbound
  1797. Reflex/GetEntryAddress                              Reflex/GetEntryAddress
  1798.  
  1799.     NAME
  1800.         GetEntryAddress  --  obtain Fido address of current entry
  1801.  
  1802.     SYNOPSIS
  1803.         RESULT = GetEntryAddress
  1804.  
  1805.     FUNCTION
  1806.         This command will return the Fido address of the current entry in
  1807.         the outbound list. The Fido address is returned in RESULT.
  1808.  
  1809.     INPUTS
  1810.         None.
  1811.  
  1812.     RETURN CODE
  1813.         0 (RC_OK)     - if a Fido address was returned in RESULT.
  1814.         5 (RC_WARN)   - if the entry didn't have a Fido address (i.e it is
  1815.                         either an orphan or an empty file).
  1816.         10 (RC_ERROR) - if the outbound list is empty.
  1817.  
  1818.     RESULT
  1819.         The Fido address of the current entry in the outbound list. In
  1820.         other words a string like "2:238/127.0" is returned.
  1821.  
  1822.     BUGS
  1823.         None known.
  1824.  
  1825.     SEE ALSO
  1826.         ChangeEntryAddress, GetEntryDate, GetEntryFilename,
  1827.         GetEntryFlowfile, GetEntryNum, GetEntrySize, GetEntryStatus,
  1828.         GetEntrySystem, GetEntryType, GetFlowEntry, SetEntryAddress
  1829. Reflex/GetEntryDate                                    Reflex/GetEntryDate
  1830.  
  1831.     NAME
  1832.         GetEntryDate  --  obtain date of current entry
  1833.  
  1834.     SYNOPSIS
  1835.         RESULT = GetEntryDate
  1836.  
  1837.     FUNCTION
  1838.         This command returns the date of the current entry in the outbound
  1839.         list. The date is returned in RESULT.
  1840.  
  1841.         All entries except file requests have en date.
  1842.  
  1843.         The returned format is:
  1844.  
  1845.             dd-mmm-yy hh:mm:ss
  1846.  
  1847.         where 'dd' is day, 'mmm' is month in letter, 'yy' is year, 'hh' is
  1848.         hours, 'mm' is minutes, and 'ss' is seconds.
  1849.  
  1850.     INPUTS
  1851.         None.
  1852.  
  1853.     RETURN CODE
  1854.         0 (RC_OK)     - if the date is returned in RESULT.
  1855.         5 (RC_WARN)   - if the current entry is a file request
  1856.         10 (RC_ERROR) - if the outbound list is empty.
  1857.  
  1858.     RESULT
  1859.         The date of the current entry in the outbound list.
  1860.  
  1861.     BUGS
  1862.         None known.
  1863.  
  1864.     SEE ALSO
  1865.         GetEntryAddress, GetEntryDate, GetEntryFilename, GetEntryFlowfile,
  1866.         GetEntryNum, GetEntryStatus, GetEntrySystem, GetEntryType,
  1867.         GetFlowEntry
  1868. Reflex/GetEntryFilename                            Reflex/GetEntryFilename
  1869.  
  1870.     NAME
  1871.         GetEntryFilename  --  obtain filename of current entry
  1872.  
  1873.     SYNOPSIS
  1874.         RESULT = GetEntryFilename
  1875.  
  1876.     FUNCTION
  1877.         This command return the filename of the current entry in the
  1878.         outbound list. This is only the filename, i.e. exclusive the
  1879.         path. The filename is returned in RESULT.
  1880.  
  1881.     INPUTS
  1882.         None.
  1883.  
  1884.     RETURN CODE
  1885.         0 (RC_OK)     - when a filename is returned in RESULT.
  1886.         10 (RC_ERROR) - if the outbound list is empty.
  1887.  
  1888.     RESULT
  1889.         The filename of the current entry in the outbound list. I.e. a
  1890.         string like "2.238.127.0.CUT" or "Reflex.lha" is returned.
  1891.  
  1892.     BUGS
  1893.         None known.
  1894.  
  1895.     SEE ALSO
  1896.         AddPart, GetEntryAddress, GetEntryDate, GetEntryFlowfile,
  1897.         GetEntryNum, GetEntrySize, GetEntryStatus, GetEntrySystem,
  1898.         GetEntryType, GetFlowEntry
  1899. Reflex/GetEntryFlowfile                            Reflex/GetEntryFlowfile
  1900.  
  1901.     NAME
  1902.         GetEntryFlowfile  --  obtain the name of the flow file
  1903.  
  1904.     SYNOPSIS
  1905.         RESULT = GetEntryFlowfile
  1906.  
  1907.     FUNCTION
  1908.         This command will return the name of the flow file that the
  1909.         current entry is listed in. This is the normal flow files with
  1910.         suffixes .FLO, .CLO, .HLO or .DLO. The command will also return
  1911.         the name of the file request files .REQ and request files .RLO.
  1912.  
  1913.         In all cases the filename inclusive full path is returned. The
  1914.         filename of the flow file is returned in RESULT.
  1915.  
  1916.     INPUTS
  1917.         None.
  1918.  
  1919.     RETURN CODE
  1920.         0 (RC_OK)     - when a filename of a flow file is returned in
  1921.                         RESULT.
  1922.         5 (RC_WARN)   - if the current entry isn't listed en a flow file
  1923.                         kind of type file. I.e. the current entry is
  1924.                         either an orphan or empty file or 4D uncompressed
  1925.                         mail.
  1926.         10 (RC_ERROR) - if the outbound list is empty.
  1927.  
  1928.     RESULT
  1929.         The filename of the flow file. In all cases the full filename
  1930.         inclusive path is returned, i.e. a string like
  1931.         "MAIL:Outbound/2.238.127.0.FLO" or "MAIL:Outbound/2.238.127.0.REQ"
  1932.         is returned.
  1933.  
  1934.     BUGS
  1935.         None known.
  1936.  
  1937.     SEE ALSO
  1938.         GetEntryAddress, GetEntryDate, GetEntryFilename, GetEntryNum,
  1939.         GetEntrySize, GetEntryStatus, GetEntrySystem, GetEntryType,
  1940.         GetFlowEntry
  1941. Reflex/GetEntryNum                                      Reflex/GetEntryNum
  1942.  
  1943.     NAME
  1944.         GetEntryNum  --  obtain entry number
  1945.  
  1946.     SYNOPSIS
  1947.         RESULT = GetEntryNum
  1948.  
  1949.     FUNCTION
  1950.         This command will return the number of the current entry in the
  1951.         outbound list. If the outbound list is empty zero is returned. The
  1952.         number is returned in result.
  1953.  
  1954.         For example this could be used to update a progress requester
  1955.         every time you have processed a node.
  1956.  
  1957.     INPUTS
  1958.         None.
  1959.  
  1960.     RETURN CODE
  1961.         0 (RC_OK) - always returned.
  1962.  
  1963.     RESULT
  1964.         The number of the entry in the outbound list. Zero is returned if
  1965.         the outbound list is empty.
  1966.  
  1967.     BUGS
  1968.         None known.
  1969.  
  1970.     SEE ALSO
  1971.         GetNumEntries
  1972. Reflex/GetEntrySize                                    Reflex/GetEntrySize
  1973.  
  1974.     NAME
  1975.         GetEntrySize  --  obtain size of current entry
  1976.  
  1977.     SYNOPSIS
  1978.         RESULT = GetEntrySize
  1979.  
  1980.     FUNCTION
  1981.         This command returns the size of the current entry in the outbound
  1982.         list. The size is returned in RESULT.
  1983.  
  1984.         All entries except file requests have en size.
  1985.  
  1986.     INPUTS
  1987.         None.
  1988.  
  1989.     RETURN CODE
  1990.         0 (RC_OK)     - if the filesize is returned in RESULT.
  1991.         5 (RC_WARN)   - if the current entry if a file request
  1992.         10 (RC_ERROR) - if the outbound list is empty.
  1993.  
  1994.     RESULT
  1995.         The size of the current entry in the outbound list.
  1996.  
  1997.     BUGS
  1998.         None known.
  1999.  
  2000.     SEE ALSO
  2001.         GetEntryAddress, GetEntryDate, GetEntryFilename, GetEntryFlowfile,
  2002.         GetEntryNum, GetEntryStatus, GetEntrySystem, GetEntryType,
  2003.         GetFlowEntry
  2004. Reflex/GetEntryStatus                                Reflex/GetEntryStatus
  2005.  
  2006.     NAME
  2007.         GetEntryStatus  --  obtain status of current entry
  2008.  
  2009.     SYNOPSIS
  2010.         RESULT = GetEntryStatus
  2011.  
  2012.     FUNCTION
  2013.         This command will obtain the status of the current entry in the
  2014.         outbound list. The status is returned in RESULT. 
  2015.  
  2016.         The status is in most cases the flavour of the file, i.e. Normal,
  2017.         Crash, Hold or Direct. Only file requests and requests at your
  2018.         system have got a different status.
  2019.  
  2020.         Orphan and empty files haven't got a status.
  2021.  
  2022.     INPUTS
  2023.         None.
  2024.  
  2025.     RETURN CODE
  2026.         0 (RC_OK)     - if a status is returned in RESULT.
  2027.         5 (RC_WARN)   - current entry has got no status (i.e. orphan or
  2028.                         empty file).
  2029.         10 (RC_ERROR) - if the outbound list is empty.
  2030.  
  2031.     RESULT
  2032.         The status of the current entry as a number:
  2033.  
  2034.             "1" - Normal (flavour of entry is normal)
  2035.             "2" - Crash  (flavour of entry is crash)
  2036.             "3" - Hold   (flavour of entry is hold)
  2037.             "4" - Direct (flavour of entry is direct)
  2038.             "5" - Freq   (file request)
  2039.             "6" - Req    (request at your system)
  2040.  
  2041.     BUGS
  2042.         None known.
  2043.  
  2044.     SEE ALSO
  2045.         ChangeEntryStatus, GetEntryAddress, GetEntryDate,
  2046.         GetEntryFilename, GetEntryFlowfile, GetEntryNum, GetEntrySize,
  2047.         GetEntrySystem, GetEntryType, GetFlowEntry, SetEntryStatus
  2048. Reflex/GetEntrySystem                                Reflex/GetEntrySystem
  2049.  
  2050.     NAME
  2051.         GetEntrySystem  --  obtain the name of the system to receive the
  2052.                             current entry
  2053.  
  2054.     SYNOPSIS
  2055.         RESULT = GetEntrySystem
  2056.  
  2057.     FUNCTION
  2058.         This command will return the name of the system to receive the
  2059.         current entry in the outbound list. The system name is returned
  2060.         in RESULT.
  2061.  
  2062.         This command naturally requires traplist.library to be able to
  2063.         return a system name.
  2064.  
  2065.     INPUTS
  2066.         None.
  2067.  
  2068.     RETURN CODE
  2069.         0 (RC_OK)     - a system name is returned in RESULT.
  2070.         5 (RC_WARN)   - if the outbound list pointer was on an orphan or
  2071.                         an empty file which doesn't contain a system name.
  2072.         10 (RC_ERROR) - if the outbound list is empty.
  2073.  
  2074.     RESULT
  2075.         The system name of the current entry in the outbound list. In
  2076.         other words a string like "Insomnia" is returned.
  2077.  
  2078.     BUGS
  2079.         None known.
  2080.  
  2081.     SEE ALSO
  2082.         GetEntryAddress, GetEntryDate, GetEntryFilename, GetEntryFlowfile,
  2083.         GetEntryNum, GetEntrySize, GetEntryStatus, GetEntryType,
  2084.         GetFlowEntry
  2085. Reflex/GetEntryType                                    Reflex/GetEntryType
  2086.  
  2087.     NAME
  2088.         GetEntryType  --  obtain type of current entry
  2089.  
  2090.     SYNOPSIS
  2091.         RESULT = GetEntryType
  2092.  
  2093.     FUNCTION
  2094.         This command obtains the type of the current entry in the outbound
  2095.         list. Reflex groups entries in 9 different groups:
  2096.  
  2097.         1. ARCMail listed in flow file (compressed mail bundle)
  2098.         2. Uncompressed mail listed in flow file (mail packet)
  2099.         3. Attached files listed in flow file
  2100.         4. Flow file entries of a missing file
  2101.         5. Uncompressed mail (4D mail packet)
  2102.         6. File requests
  2103.         7. Orphan files
  2104.         8. Empty files
  2105.         9. Requests at your system
  2106.  
  2107.         The type is returned in RESULT.
  2108.  
  2109.     INPUTS
  2110.         None.
  2111.  
  2112.     RETURN CODE
  2113.         0 (RC_OK)     - when a type is returned in RESULT.
  2114.         10 (RC_ERROR) - if the outbound list is empty.
  2115.  
  2116.     RESULT
  2117.         The type of the current entry in the outbound list:
  2118.  
  2119.             "1" - Mail bundles listed in flow files
  2120.             "2" - Uncompressed mail packets listed in flow files
  2121.             "3" - Attached file listed in flow files
  2122.             "4" - Flow file entries of missing files
  2123.             "5" - 4D uncompressed mail packets
  2124.             "6" - File requests
  2125.             "7" - Orphan files
  2126.             "8" - Empty files
  2127.             "9" - Requests at your system
  2128.  
  2129.     BUGS
  2130.         None known.
  2131.  
  2132.     SEE ALSO
  2133.         GetEntryAddress, GetEntryDate, GetEntryFilename, GetEntryFlowfile,
  2134.         GetEntryNum, GetEntrySize, GetEntryStatus, GetEntrySystem,
  2135.         GetFlowEntry
  2136. Reflex/GetFlowEntry                                    Reflex/GetFlowEntry
  2137.  
  2138.     NAME
  2139.         GetFlowEntry  --  obtain current entry's flow file entry
  2140.  
  2141.     SYNOPSIS
  2142.         RESULT = GetFlowEntry
  2143.  
  2144.     FUNCTION
  2145.         This command returns the current entry's verbatim flow file entry.
  2146.         I.e. the command returns exactly how the entry is listed in its
  2147.         flow file. The flow file entry is returned in RESULT.
  2148.  
  2149.         For example when mail is exported to 2:238/127.0 it result in a
  2150.         mail bundle, e.g. 2.238.127.0.TH0 listed in 2.238.127.0.FLO. For
  2151.         this example this command will return exactly how it is listed
  2152.         in the flow file, i.e. "#MAIL:Outbound/2.238.127.0.TH0".
  2153.  
  2154.         Please notice its is the verbatim entry that is returned. This
  2155.         means that any mailer actions (#, ^, -, and @) is included in
  2156.         the returned string. As an ARexx programmer it is you job to
  2157.         check for such mailer actions and strip them if you only need the
  2158.         full path to the listed file.
  2159.  
  2160.         Requests at your system are handled like normal flow files. File
  2161.         request files are accepted too - these will just return the file
  2162.         to be requested.
  2163.  
  2164.     INPUTS
  2165.         None.
  2166.  
  2167.     RETURN CODE
  2168.         0 (RC_OK)     - if a flow file entry is returned in RESULT.
  2169.         5 (RC_WARN)   - if the current entry isn't listed in a flow file
  2170.                         or similar file.
  2171.         10 (RC_ERROR) - if the outbound list is empty.
  2172.  
  2173.     RESULT
  2174.         The verbatim flow file entry of the current entry in the outbound
  2175.         list.
  2176.  
  2177.     BUGS
  2178.         None known.
  2179.  
  2180.     SEE ALSO
  2181.         GetEntryAddress, GetEntryDate, GetEntryFilename, GetEntryFlowfile,
  2182.         GetEntryNum, GetEntrySize, GetEntryStatus, GetEntrySystem,
  2183.         GetEntryType
  2184. Reflex/GetLogfile                                        Reflex/GetLogfile
  2185.  
  2186.     NAME
  2187.         GetLogfile  --  obtain name of log file
  2188.  
  2189.     SYNOPSIS
  2190.         RESULT = GetLogfile
  2191.  
  2192.     FUNCTION
  2193.         This command returns the name of the logfile inclusive full path
  2194.         as specified in the Files configuration. The filename is returned
  2195.         in RESULT.
  2196.  
  2197.     INPUTS
  2198.         None.
  2199.  
  2200.     RETURN CODE
  2201.         0 (RC_OK)     - when a filename is returned in RESULT.
  2202.         10 (RC_ERROR) - if no logfile is specified in the Files
  2203.                         configuration.
  2204.  
  2205.     RESULT
  2206.         The name of the logfile, inclusive full path, e.g.
  2207.         "MAIL:log/Reflex.log".
  2208.  
  2209.     BUGS
  2210.         None known.
  2211.  
  2212.     SEE ALSO
  2213.         GetARexxDir, GetAttachDir, GetNodelist, GetOutbound, WriteLog
  2214. Reflex/GetNodelist                                      Reflex/GetNodelist
  2215.  
  2216.     NAME
  2217.         GetNodelist  --  obtain path to nodelist directory
  2218.  
  2219.     SYNOPSIS
  2220.         RESULT = GetNodelist
  2221.  
  2222.     FUNCTION
  2223.         This command returns the path to the nodelist directory as
  2224.         specified in the Files configuration. The path is returned in
  2225.         RESULT.
  2226.  
  2227.     INPUTS
  2228.         None.
  2229.  
  2230.     RETURN CODE
  2231.         0 (RC_OK)     - when the nodelist path is returned in RESULT.
  2232.         10 (RC_ERROR) - if no nodelist directory was specified.
  2233.  
  2234.     RESULT
  2235.         The path to the nodelist directory, e.g. "Nodelist:"
  2236.  
  2237.     BUGS
  2238.         None known.
  2239.  
  2240.     SEE ALSO
  2241.         AddPart, GetARexxDir, GetAttachDir, GetLogfile, GetOutbound
  2242. Reflex/GetNumEntries                                  Reflex/GetNumEntries
  2243.  
  2244.     NAME
  2245.         GetNumEntries  -- obtain number of entries in outbound list
  2246.  
  2247.     SYNOPSIS
  2248.         RESULT = GetNumEntries
  2249.  
  2250.     FUNCTION
  2251.         This command will in RESULT return the number of entries in the
  2252.         outbound list (currently this is the same as the number of entries
  2253.         in the main window listview - but this might change in a future
  2254.         release).
  2255.  
  2256.         Please notice that the number of entries in the outbound list NOT
  2257.         is the same as the number of files in the outbound directory.
  2258.  
  2259.     INPUTS
  2260.         None.
  2261.  
  2262.     RETURN CODE
  2263.         0 (RC_OK) - is always returned.
  2264.  
  2265.     RESULT
  2266.         The number of entries in the outbound list.
  2267.  
  2268.     BUGS
  2269.         None known.
  2270.  
  2271.     SEE ALSO
  2272.         GetEntryNum
  2273. Reflex/GetOutbound                                      Reflex/GetOutbound
  2274.  
  2275.     NAME
  2276.         GetOutbound  --  obtain path to outbound directory
  2277.  
  2278.     SYNOPSIS
  2279.         RESULT = GetOutbound
  2280.  
  2281.     FUNCTION
  2282.         This command returns the path to the outbound directory as
  2283.         specified in the Files configuration. The path is returned in
  2284.         RESULT.
  2285.  
  2286.     INPUTS
  2287.         None.
  2288.  
  2289.     RETURN CODE
  2290.         0 (RC_OK)     - when the path to the outbound directory is
  2291.                         returned in RESULT.
  2292.         10 (RC_ERROR) - if no outbound directory was specified (this
  2293.                         should never occur since Reflex shouldn't start
  2294.                         without an outbound directory).
  2295.  
  2296.     RESULT
  2297.         The outbound directory, e.g. "MAIL:Outbound"
  2298.  
  2299.     BUGS
  2300.         None known.
  2301.  
  2302.     SEE ALSO
  2303.         AddPart, GetARexxDir, GetAttachDir, GetEntryFilename, GetLogfile,
  2304.         GetNodelist
  2305. Reflex/GetPollcommand                                Reflex/GetPollcommand
  2306.  
  2307.     NAME
  2308.         GetPollcommand  --  obtain poll command
  2309.  
  2310.     SYNOPSIS
  2311.         RESULT = GetPollCommand
  2312.  
  2313.     FUNCTION
  2314.         This command will return the poll command specified in the Mailer
  2315.         configuration. The poll command is returned in RESULT.
  2316.  
  2317.     INPUTS
  2318.         None.
  2319.  
  2320.     RETURN CODE
  2321.         0 (RC_OK)     - when a poll command is returned in RESULT.
  2322.         10 (RC_ERROR) - if no poll command is specified.
  2323.  
  2324.     RESULT
  2325.         The poll command, e.g. "TrapDoor CALL %n".
  2326.  
  2327.     BUGS
  2328.         None known.
  2329.  
  2330.     SEE ALSO
  2331.         FormatPollcommand, GetPollpattern, GetPort, Poll, PollEntry
  2332. Reflex/GetPollpattern                                Reflex/GetPollpattern
  2333.  
  2334.     NAME
  2335.         GetPollpattern  --  obtain poll pattern
  2336.  
  2337.     SYNOPSIS
  2338.         RESULT = GetPollpattern
  2339.  
  2340.     FUNCTION
  2341.         This command will return the poll pattern specified in the Mailer
  2342.         configuration. The poll pattern is returned in RESULT.
  2343.  
  2344.     INPUTS
  2345.         None.
  2346.  
  2347.     RETURN CODE
  2348.         0 (RC_OK)     - when a poll pattern is returned in RESULT.
  2349.         10 (RC_ERROR) - if no poll pattern is specified.
  2350.  
  2351.     RESULT
  2352.         The poll pattern, e.g. "#[0-9]:#[0-9]/#[0-9](%|.#[0-9])".
  2353.  
  2354.     BUGS
  2355.         None known.
  2356.  
  2357.     SEE ALSO
  2358.         GetPollcommand, GetPort, MatchPollpattern
  2359. Reflex/GetPort                                              Reflex/GetPort
  2360.  
  2361.     NAME
  2362.         GetPort  --  obtain default port for poll commmand
  2363.  
  2364.     SYNOPSIS
  2365.         RESULT = GetPort
  2366.  
  2367.     FUNCTION
  2368.         This command returns the default port to be used instead of the
  2369.         %p formatting code in the poll command. The default portname is
  2370.         specified in the Mailer configuration. The portname is returned
  2371.         in RESULT.
  2372.  
  2373.     INPUTS
  2374.         None.
  2375.  
  2376.     RETURN CODE
  2377.         0 (RC_OK)     - when a portname is returned in RESULT.
  2378.         10 (RC_ERROR) - if no default port is specified.
  2379.  
  2380.     RESULT
  2381.         The name of the default port, e.g. "TrapDoor".
  2382.  
  2383.     BUGS
  2384.         None known.
  2385.  
  2386.     SEE ALSO
  2387.         FormatPollcommand, GetPollcommand, GetPollpattern, Poll, PollEntry
  2388. Reflex/GetPubscreen                                    Reflex/GetPubscreen
  2389.  
  2390.     NAME
  2391.         GetPubscreen  --  obtain name of public screen
  2392.  
  2393.     SYNOPSIS
  2394.         RESULT = GetPubscreen
  2395.  
  2396.     FUNCTION
  2397.         This command will return the name of the public screen as
  2398.         specified in the GUI configuration. The public screen name
  2399.         is returned in RESULT.
  2400.  
  2401.     INPUTS
  2402.         None.
  2403.  
  2404.     RETURN CODE
  2405.         0 (RC_OK)     - if a public screen name is returned in RESULT.
  2406.         10 (RC_OK)    - if no public screen name is specified.
  2407.  
  2408.     RESULT
  2409.         The public screen name.
  2410.  
  2411.     BUGS
  2412.         None known.
  2413.  
  2414.     SEE ALSO
  2415. Reflex/GetReflexAuthor                              Reflex/GetReflexAuthor
  2416.  
  2417.     NAME
  2418.         GetReflexAuthor  --  obtain name of Reflex author
  2419.  
  2420.     SYNOPSIS
  2421.         RESULT = GetReflexAuthor
  2422.  
  2423.     FUNCTION
  2424.         This command is useless! It returns my name in RESULT.
  2425.  
  2426.     INPUTS
  2427.         None.
  2428.  
  2429.     RETURN CODE
  2430.         0 (RC_OK) - always returned.
  2431.  
  2432.     RESULT
  2433.         My name.
  2434.  
  2435.     BUGS
  2436.         None known - except my weird mind.
  2437.  
  2438.     SEE ALSO
  2439.         GetReflexDate, GetReflexDesc, GetReflexName
  2440. Reflex/GetReflexDate                                  Reflex/GetReflexDate
  2441.  
  2442.     NAME
  2443.         GetReflexDate  --  obtain Reflex compilataion date
  2444.  
  2445.     SYNOPSIS
  2446.         RESULT = GetReflexDate
  2447.  
  2448.     FUNCTION
  2449.         This command is more or less useless. It returns the compilation
  2450.         date of Reflex.
  2451.  
  2452.     INPUTS
  2453.         None.
  2454.  
  2455.     RETURN CODE
  2456.         0 (RC_OK) - always returned.
  2457.  
  2458.     RESULT
  2459.         The compilation date. If I remember correct in the following
  2460.         format "(d.m.y)" where d, m and y are day, month and year,
  2461.         respectively - all one or two digit numbers.
  2462.  
  2463.     BUGS
  2464.         None known.
  2465.  
  2466.     SEE ALSO
  2467.         GetReflexAuthor, GetReflexDesc, GetReflexName
  2468. Reflex/GetReflexDesc                                  Reflex/GetReflexDesc
  2469.  
  2470.     NAME
  2471.         GetReflexDesc  --  obtain program description
  2472.  
  2473.     SYNOPSIS
  2474.         RESULT = GetReflexDesc
  2475.  
  2476.     FUNCTION
  2477.         "Useless", I say. "Correct", you agree. This command returns a
  2478.         localized program description.
  2479.  
  2480.     INPUTS
  2481.         None.
  2482.  
  2483.     RETURN CODE
  2484.         0 (RC_OK) - always returned.
  2485.  
  2486.     RESULT
  2487.         Program description, localized. Currently "Fido 4D Outbound
  2488.         Manager".
  2489.  
  2490.     BUGS
  2491.         None known.
  2492.  
  2493.     SEE ALSO
  2494.         GetReflexAuthor, GetReflexDate, GetReflexName
  2495. Reflex/GetReflexName                                  Reflex/GetReflexName
  2496.  
  2497.     NAME
  2498.         GetReflexName  --  obtain program name
  2499.  
  2500.     SYNOPSIS
  2501.         RESULT = GetReflexName
  2502.  
  2503.     FUNCTION
  2504.         Was I bored or what? This is the fourth useless command in a
  2505.         row. It returns the program name - as if you didn't know.
  2506.  
  2507.     INPUTS
  2508.         None.
  2509.  
  2510.     RETURN CODE
  2511.         0 (RC_OK) - always returned.
  2512.  
  2513.     RESULT
  2514.         Program name; currently "Reflex".
  2515.  
  2516.     BUGS
  2517.         None.
  2518.  
  2519.     SEE ALSO
  2520.         GetReflexAuthor, GetReflexDate, GetReflexDesc
  2521. Reflex/GetReflexRelease                            Reflex/GetReflexRelease
  2522.  
  2523.     NAME
  2524.         GetReflexRelease  --  obtain program release
  2525.  
  2526.     SYNOPSIS
  2527.         RESULT = GetReflexRelease
  2528.  
  2529.     FUNCTION
  2530.         This command can be used to obtain the program release. You can
  2531.         use this command to check against a release if certain commands
  2532.         in a future isn't available in all versions.
  2533.  
  2534.     INPUTS
  2535.         None.
  2536.  
  2537.     RETURN CODE
  2538.         0 (RC_OK) - always returned.
  2539.  
  2540.     RESULT
  2541.         Program release.
  2542.  
  2543.     BUGS
  2544.         None known.
  2545.  
  2546.     SEE ALSO
  2547.         GetReflexVersion
  2548. Reflex/GetReflexVersion                            Reflex/GetReflexVersion
  2549.  
  2550.     NAME
  2551.         GetReflexVersion  --  obtain program version
  2552.  
  2553.     SYNOPSIS
  2554.         RESULT = GetReflexVersion
  2555.  
  2556.     FUNCTION
  2557.         This command returns the program version.
  2558.  
  2559.     INPUTS
  2560.         None.
  2561.  
  2562.     RETURN CODE
  2563.         0 (RC_OK) - always returned.
  2564.  
  2565.     RESULT
  2566.         Program version.
  2567.  
  2568.     BUGS
  2569.         None known.
  2570.  
  2571.     SEE ALSO
  2572.         GetReflexRelease
  2573. Reflex/HideGUI                                              Reflex/HideGUI
  2574.  
  2575.     NAME
  2576.         HideGUI  --  hide the GUI of Reflex
  2577.  
  2578.     SYNOPSIS
  2579.         HideGUI
  2580.  
  2581.     FUNCTION
  2582.         This command will put away the graphic user interface. The GUI
  2583.         does not have to be open to use this command.
  2584.  
  2585.         If your ARexx script hides the GUI when it starts it should
  2586.         reopen the GUI before it ends if the GUI was open when it
  2587.         started.
  2588.  
  2589.     INPUTS
  2590.         None.
  2591.  
  2592.     RETURN CODE
  2593.         0 (RC_OK) - is always returned.
  2594.  
  2595.     RESULT
  2596.         None.
  2597.  
  2598.     BUGS
  2599.         None known.
  2600.  
  2601.     SEE ALSO
  2602.         IsGUI, ShowGUI
  2603. Reflex/IsCfgChanged                                    Reflex/IsCfgChanged
  2604.  
  2605.     NAME
  2606.         IsCfgChanged  --  has settings changed?
  2607.  
  2608.     SYNOPSIS
  2609.         IsCfgChanged
  2610.  
  2611.     FUNCTION
  2612.         This command reports the state of the settings.
  2613.  
  2614.     INPUTS
  2615.         None.
  2616.  
  2617.     RETURN CODE
  2618.         0 (RC_OK)   - no changes have been made.
  2619.         5 (RC_WARN) - changes have been made to the settings.
  2620.  
  2621.     RESULT
  2622.         None.
  2623.  
  2624.     BUGS
  2625.         None known.
  2626.  
  2627.     SEE ALSO
  2628.         SaveSettings
  2629. Reflex/IsEmpty                                              Reflex/IsEmpty
  2630.  
  2631.     NAME
  2632.         IsEmpty  --  is there empty files in outbound list?
  2633.  
  2634.     SYNOPSIS
  2635.         IsEmpty
  2636.  
  2637.     FUNCTION
  2638.         This command tells you if there exists empty files in the
  2639.         outbound list.
  2640.  
  2641.     INPUTS
  2642.         None.
  2643.  
  2644.     RETURN CODE
  2645.         0 (RC_OK)   - if the outbound list doesn't contain empty files.
  2646.         5 (RC_WARN) - if the outbound list contains empty files
  2647.  
  2648.     RESULT
  2649.         None.
  2650.  
  2651.     BUGS
  2652.         None known.
  2653.  
  2654.     SEE ALSO
  2655.         IsFlowFile, IsFlowMail, IsFlowPkt, IsFreq, IsMissing, IsOrphan,
  2656.         IsPkt, IsReq
  2657. Reflex/IsFlowFile                                        Reflex/IsFlowFile
  2658.  
  2659.     NAME
  2660.         IsFlowFile  --  is there attached files in outbound list?
  2661.  
  2662.     SYNOPSIS
  2663.         IsFlowFile NODE/K
  2664.  
  2665.     FUNCTION
  2666.         This command reports if there exists attached files in the
  2667.         outbound list.
  2668.  
  2669.         Specifying the NODE option enables you to check for attached files
  2670.         for a certain node. This requires traplist.library.
  2671.  
  2672.     INPUTS
  2673.         NODE/K - a Fido address for which to check for attached files
  2674.                  in the outbound list. traplist.library is needed too use
  2675.                  the NODE/K option.
  2676.  
  2677.     RETURN CODE
  2678.         0 (RC_OK)     - there isn't any attached files in the outbound
  2679.                         list (for the node in question).
  2680.         5 (RC_WARN)   - if there does indeed exist attached files in the
  2681.                         outbound list (for the node in question).
  2682.         10 (RC_ERROR) - (only with NODE/K) traplist.library not available.
  2683.         10 (RC_ERROR) - (only with NODe/K) specified Fido address not
  2684.                         valid.
  2685.  
  2686.     RESULT
  2687.         None.
  2688.  
  2689.     BUGS
  2690.         None known.
  2691.  
  2692.     SEE ALSO
  2693.         IsEmpty, IsFlowMail, IsFlowPkt, IsFreq, IsMissing, IsOrphan,
  2694.         IsPkt, IsReq
  2695. Reflex/IsFlowMail                                        Reflex/IsFlowMail
  2696.  
  2697.     NAME
  2698.         IsFlowMail  --  is there compressed mail bundles in outbound list?
  2699.  
  2700.     SYNOPSIS
  2701.         IsFlowMail NODE/K
  2702.  
  2703.     FUNCTION
  2704.         This command reports if there exists compressed mail bundles in
  2705.         the outbound list.
  2706.  
  2707.         Specifying the NODE option enables you to check for compressed
  2708.         mail bundles for a certain node. This requires traplist.library.
  2709.  
  2710.     INPUTS
  2711.         NODE/K - a Fido address for which to check for compressed mail
  2712.                  bundles in the outbound list. traplist.library is needed
  2713.                  to use the NODE/K option.
  2714.  
  2715.     RETURN CODE
  2716.         0 (RC_OK)     - there isn't any compressed mail bundles in the
  2717.                         outbound list (for the node in question).
  2718.         5 (RC_WARN)   - if there does indeed exist compressed mail bundles
  2719.                         in the outbound list (for the node in question).
  2720.         10 (RC_ERROR) - (only with NODE/K) traplist.library not available.
  2721.         10 (RC_ERROR) - (only with NODe/K) specified Fido address not
  2722.                         valid.
  2723.  
  2724.     RESULT
  2725.         None.
  2726.  
  2727.     BUGS
  2728.         None known.
  2729.  
  2730.     SEE ALSO
  2731.         IsEmpty, IsFlowFile, IsFlowPkt, IsFreq, IsMissing, IsOrphan,
  2732.         IsPkt, IsReq
  2733. Reflex/IsFlowPkt                                          Reflex/IsFlowPkt
  2734.  
  2735.     NAME
  2736.         IsFlowPkt  --  is there uncompressed mail listed in flow files in
  2737.                        outbound list?
  2738.  
  2739.     SYNOPSIS
  2740.         IsFlowPkt NODE/K
  2741.  
  2742.     FUNCTION
  2743.         This command reports if there exists uncompressed mail listed in
  2744.         flow files in the outbound list.
  2745.  
  2746.         Specifying the NODE option enables you to check for uncompressed
  2747.         mail listed in flow files for a certain node. This requires
  2748.         traplist.library.
  2749.  
  2750.     INPUTS
  2751.         NODE/K - a Fido address for which to check for uncompressed mail
  2752.                  listed in flow files in the outbound list.
  2753.                  traplist.library is needed to use the NODE/K option.
  2754.  
  2755.     RETURN CODE
  2756.         0 (RC_OK)     - there isn't any uncompressed mail listed in flow
  2757.                         files in the outbound list (for the node in
  2758.                         question).
  2759.         5 (RC_WARN)   - if there does indeed exist uncompressed mail
  2760.                         listed in flow files in the outbound list (for the
  2761.                         node in question).
  2762.         10 (RC_ERROR) - (only with NODE/K) traplist.library not available.
  2763.         10 (RC_ERROR) - (only with NODe/K) specified Fido address not
  2764.                         valid.
  2765.  
  2766.     RESULT
  2767.         None.
  2768.  
  2769.     BUGS
  2770.         None known.
  2771.  
  2772.     SEE ALSO
  2773.         IsEmpty, IsFlowFile, IsFlowMail, IsFreq, IsMissing, IsOrphan,
  2774.         IsPkt, IsReq
  2775. Reflex/IsFreq                                                Reflex/IsFreq
  2776.  
  2777.     NAME
  2778.         IsFreq  --  is there file requests in outbound list?
  2779.  
  2780.     SYNOPSIS
  2781.         IsFreq NODE/K
  2782.  
  2783.     FUNCTION
  2784.         This command reports if there exists file requests in the outbound
  2785.         list.
  2786.  
  2787.         Specifying the NODE option enables you to check for file requests
  2788.         for a certain node. This requires traplist.library.
  2789.  
  2790.     INPUTS
  2791.         NODE/K - a Fido address for which to check for file requests in
  2792.                  the outbound list. traplist.library is needed to use the
  2793.                  NODE/K option.
  2794.  
  2795.     RETURN CODE
  2796.         0 (RC_OK)     - there isn't any file requests the outbound list
  2797.                         (for the node in question).
  2798.         5 (RC_WARN)   - if there does indeed exist file requests in the
  2799.                         outbound list (for the node in question).
  2800.         10 (RC_ERROR) - (only with NODE/K) traplist.library not available.
  2801.         10 (RC_ERROR) - (only with NODe/K) specified Fido address not
  2802.                         valid.
  2803.  
  2804.     RESULT
  2805.         None.
  2806.  
  2807.     BUGS
  2808.         None known.
  2809.  
  2810.     SEE ALSO
  2811.         IsEmpty, IsFlowFile, IsFlowMail, IsFlowPkt, IsMissing, IsOrphan,
  2812.         IsPkt, IsReq
  2813. Reflex/IsGUI                                                  Reflex/IsGUI
  2814.  
  2815.     NAME
  2816.         IsGUI  --  check state of Reflex GUI
  2817.  
  2818.     SYNOPSIS
  2819.         IsGUI
  2820.  
  2821.     FUNCTION
  2822.         Reports the current state of the main graphic user interface.
  2823.  
  2824.     INPUTS
  2825.         None.
  2826.  
  2827.     RETURN CODE
  2828.         0 (RC_OK)   - GUI is closed.
  2829.         5 (RC_WARN) - GUI is open.
  2830.  
  2831.     RESULT
  2832.         None.
  2833.  
  2834.     BUGS
  2835.         None known.
  2836.  
  2837.     SEE ALSO
  2838.         HideGUI, ShowGUI
  2839. Reflex/IsMissing                                          Reflex/IsMissing
  2840.  
  2841.     NAME
  2842.         IsMissing  --  is there flow file entries of missing files in
  2843.                        outbound list?
  2844.  
  2845.     SYNOPSIS
  2846.         IsMissing NODE/K
  2847.  
  2848.     FUNCTION
  2849.         This command reports if there exists flow file entries of missing
  2850.         files in the outbound list.
  2851.  
  2852.         Specifying the NODE option enables you to check for flow file
  2853.         entries of missing files for a certain node. This requires
  2854.         traplist.library.
  2855.  
  2856.     INPUTS
  2857.         NODE/K - a Fido address for which to check for flow file entries
  2858.                  of missing files in the outbound list. traplist.library
  2859.                  is needed to use the NODE/K option.
  2860.  
  2861.     RETURN CODE
  2862.         0 (RC_OK)     - there isn't any flow file entries of missing files
  2863.                         in the outbound list (for the node in question).
  2864.         5 (RC_WARN)   - if there does indeed exist flow file entries of
  2865.                         missing file entries in the outbound list (for the
  2866.                         node in question).
  2867.         10 (RC_ERROR) - (only with NODE/K) traplist.library not available.
  2868.         10 (RC_ERROR) - (only with NODe/K) specified Fido address not
  2869.                         valid.
  2870.  
  2871.     RESULT
  2872.         None.
  2873.  
  2874.     BUGS
  2875.         None known.
  2876.  
  2877.     SEE ALSO
  2878.         IsEmpty, IsFlowFile, IsFlowMail, IsFlowPkt, IsFreq, IsOrphan,
  2879.         IsPkt, IsReq
  2880. Reflex/IsNode                                                Reflex/IsNode
  2881.  
  2882.     NAME
  2883.         IsNode  --  check if a node is listed in outbound list
  2884.  
  2885.     SYNOPSIS
  2886.         IsNode NODE/A
  2887.  
  2888.     FUNCTION
  2889.         This command tells you if a certain node is listed in the
  2890.         outbound list.
  2891.  
  2892.         The command requires currently traplist.library.
  2893.  
  2894.     INPUTS
  2895.         NODE/A - Fido address of node to look for in outbound list.
  2896.  
  2897.     RETURN CODE
  2898.         0 (RC_OK)     - if node is listed in outbound list.
  2899.         5 (RC_WARN)   - if node isn't listed in outbound list.
  2900.         10 (RC_ERROR) - traplist.library not available.
  2901.         10 (RC_ERROR) - specified Fido address not valid.
  2902.  
  2903.     RESULT
  2904.         None.
  2905.  
  2906.     BUGS
  2907.         None known.
  2908.  
  2909.     SEE ALSO
  2910.         FindNode
  2911. Reflex/IsOrphan                                            Reflex/IsOrphan
  2912.  
  2913.     NAME
  2914.         IsEmpty  --  is there orphan files in outbound list?
  2915.  
  2916.     SYNOPSIS
  2917.         IsEmpty
  2918.  
  2919.     FUNCTION
  2920.         This command tells you if there exists orphan files in the
  2921.         outbound list.
  2922.  
  2923.     INPUTS
  2924.         None.
  2925.  
  2926.     RETURN CODE
  2927.         0 (RC_OK)   - if the outbound list doesn't contain orphan files.
  2928.         5 (RC_WARN) - if the outbound list contains empty files
  2929.  
  2930.     RESULT
  2931.         None.
  2932.  
  2933.     BUGS
  2934.         None known.
  2935.  
  2936.     SEE ALSO
  2937.         IsEmpty, IsFlowFile, IsFlowMail, IsFlowPkt, IsFreq, IsMissing,
  2938.         IsPkt, IsReq
  2939. Reflex/IsPkt                                                  Reflex/IsPkt
  2940.  
  2941.     NAME
  2942.         IsPkt  --  is there 4D uncompressed mail in outbound list?
  2943.  
  2944.     SYNOPSIS
  2945.         IsPkt NODE/K
  2946.  
  2947.     FUNCTION
  2948.         This command reports if there exists 4D uncompressed mail in the
  2949.         outbound list.
  2950.  
  2951.         Specifying the NODE option enables you to check for 4D
  2952.         uncompressed mail for a certain node. This requires
  2953.         traplist.library.
  2954.  
  2955.     INPUTS
  2956.         NODE/K - a Fido address for which to check for 4D uncompressed
  2957.                  mail in the outbound list. traplist.library is needed to
  2958.                  use the NODE/K option.
  2959.  
  2960.     RETURN CODE
  2961.         0 (RC_OK)     - there isn't any 4D uncompressed mail in the
  2962.                         outbound list (for the node in question).
  2963.         5 (RC_WARN)   - if there does indeed exist 4D uncompressed mail in
  2964.                         the outbound list (for the node in question).
  2965.         10 (RC_ERROR) - (only with NODE/K) traplist.library not available.
  2966.         10 (RC_ERROR) - (only with NODe/K) specified Fido address not
  2967.                         valid.
  2968.  
  2969.     RESULT
  2970.         None.
  2971.  
  2972.     BUGS
  2973.         None known.
  2974.  
  2975.     SEE ALSO
  2976.         IsEmpty, IsFlowFile, IsFlowMail, IsFlowPkt, IsFreq, IsMissing,
  2977.         IsOrphan, IsReq
  2978. Reflex/IsRegistered                                    Reflex/IsRegistered
  2979.  
  2980.     NAME
  2981.         IsRegistered  --  check state of Reflex
  2982.  
  2983.     SYNOPSIS
  2984.         IsRegistered
  2985.  
  2986.     FUNCTION
  2987.         Reports the state of Reflex; registered version or unregistered
  2988.         evaluation version.
  2989.  
  2990.     INPUTS
  2991.         None.
  2992.  
  2993.     RETURN CODE
  2994.         0 (RC_OK)   - unregistered evaluation version.
  2995.         5 (RC_WARN) - registered version.
  2996.  
  2997.     RESULT
  2998.         None.
  2999.  
  3000.     BUGS
  3001.         None known.
  3002.  
  3003.     SEE ALSO
  3004. Reflex/IsReq                                                  Reflex/IsReq
  3005.  
  3006.     NAME
  3007.         IsReq  --  is there requests at your system in outbound list?
  3008.  
  3009.     SYNOPSIS
  3010.         IsReq NODE/K
  3011.  
  3012.     FUNCTION
  3013.         This command reports if there exists requests at your system in
  3014.         the outbound list.
  3015.  
  3016.         Specifying the NODE option enables you to check for requests at
  3017.         your system for a certain node. This requires traplist.library.
  3018.  
  3019.     INPUTS
  3020.         NODE/K - a Fido address for which to check for requests at your
  3021.                  system in the outbound list. traplist.library is needed
  3022.                  to use the NODE/K option.
  3023.  
  3024.     RETURN CODE
  3025.         0 (RC_OK)     - there isn't any requests at your system in the
  3026.                         outbound list (for the node in question).
  3027.         5 (RC_WARN)   - if there does indeed exist requests at your system
  3028.                         in the outbound list (for the node in question).
  3029.         10 (RC_ERROR) - (only with NODE/K) traplist.library not available.
  3030.         10 (RC_ERROR) - (only with NODE/K) specified Fido address not
  3031.                         valid.
  3032.  
  3033.     RESULT
  3034.         None.
  3035.  
  3036.     BUGS
  3037.         None known.
  3038.  
  3039.     SEE ALSO
  3040.         IsEmpty, IsFlowFile, IsFlowMail, IsFlowPkt, IsFreq, IsMissing,
  3041.         IsOrphan, IsPkt
  3042. Reflex/LastEntry                                          Reflex/LastEntry
  3043.  
  3044.     NAME
  3045.         LastEntry  --  move outbound list pointer to last entry
  3046.  
  3047.     SYNOPSIS
  3048.         LastEntry
  3049.  
  3050.     FUNCTION
  3051.         This command moves the outbound list pointer to the last entry in
  3052.         the outbound list.
  3053.  
  3054.     INPUTS
  3055.         None.
  3056.  
  3057.     RETURN CODE
  3058.         0 (RC_OK)     - if the outbound list pointer was moved to the last
  3059.                         entry in the outbound list.
  3060.         10 (RC_ERROR) - if the outbound list is empty.
  3061.  
  3062.     RESULT
  3063.         None.
  3064.  
  3065.     BUGS
  3066.         None known.
  3067.  
  3068.     SEE ALSO
  3069.         FindNextNode, FindNode, FirstEmpty, FirstEntry, FirstNode,
  3070.         FirstOrphan, NextEntry, NextNode, NextNodeEntry, PrevEntry,
  3071.         PrevNode, PrevNodeEntry
  3072. Reflex/LockARexx                                          Reflex/LockARexx
  3073.  
  3074.     NAME
  3075.         LockARexx  --  obtain ARexx ownership of Reflex
  3076.  
  3077.     SYNOPSIS
  3078.         LockARexx
  3079.  
  3080.     FUNCTION
  3081.         This command gives you exclusive usage of Reflex' ARexx port.
  3082.         Only your script is able to communicate with Reflex when Reflex
  3083.         is ARexx locked by your script.
  3084.  
  3085.         Using LockARexx will prevent other scripts from interfering if
  3086.         you're performing delicate operations on the outbound directory
  3087.         like deleting files.
  3088.  
  3089.         When Reflex is ARexx locked all ARexx commands will give a return
  3090.         code of 20 (RC_FATAL) to all scripts except the one that ARexx
  3091.         locked Reflex.
  3092.  
  3093.         Having implemented ARexx locking means that all scripts ought
  3094.         to ARexx lock Reflex in the beginning of the script. If you do
  3095.         not ARexx lock Reflex another script might steal Reflex from you
  3096.         if that script uses ARexx locking.
  3097.  
  3098.         It is very important that you remember to ARexx unlock Reflex
  3099.         before your script ends. If not you will not be able to access
  3100.         Reflex' ARexx port, because only your script (and ONLY yours)
  3101.         could have had unlocked the ARexx port. Therefore use of ARexx
  3102.         'onerror' is highly recommended.
  3103.  
  3104.         If you while developing ARexx scripts end with a Reflex that is
  3105.         both GUI and ARexx locked you can quit Reflex by sending Reflex a
  3106.         CTRL-C or CTRL-E. No need to reboot.
  3107.  
  3108.     INPUTS
  3109.         None.
  3110.  
  3111.     RETURN CODE
  3112.         0 (RC_OK) - always returned.
  3113.  
  3114.     RESULT
  3115.         None.
  3116.  
  3117.     BUGS
  3118.         None known.
  3119.  
  3120.     SEE ALSO
  3121.         LockGUI, QueryOwnership, UnlockARexx
  3122. Reflex/LockGUI                                              Reflex/LockGUI
  3123.  
  3124.     NAME
  3125.         LockGUI  --  disable all user input
  3126.  
  3127.     SYNOPSIS
  3128.         LockGUI
  3129.  
  3130.     FUNCTION
  3131.         This command will lock the GUI, i.e. all user input is disabled.
  3132.         This command must be matched with a UnlockGUI (for this use of
  3133.         ARexx 'onerror' is recommended). Locking the GUI will prevent that
  3134.         the user interferes with the actions of an ARexx script.
  3135.  
  3136.         Normal use of LockGUI would be to lock the GUI at the start of
  3137.         a script and unlock it just before the script ends.
  3138.  
  3139.     INPUTS
  3140.         None.
  3141.  
  3142.     RETURN CODE
  3143.         0 (RC_OK) - is always returned.
  3144.  
  3145.     RESULT
  3146.         None.
  3147.  
  3148.     BUGS
  3149.         None known.
  3150.  
  3151.     SEE ALSO
  3152.         UnlockGUI, LockARexx
  3153. Reflex/Maintenance                                      Reflex/Maintenance
  3154.  
  3155.     NAME
  3156.         Maintenance  --  perform a maintenance on outbound directory
  3157.  
  3158.     SYNOPSIS
  3159.         Maintenance
  3160.  
  3161.     FUNCTION
  3162.         When Reflex performs a maintenance on the outbound directory three
  3163.         types of entries can be affected:
  3164.  
  3165.         - empty files (files of size zero with no destination) will be
  3166.           deleted
  3167.         - orphan files (other files with no destination) will be deleted
  3168.         - entries of missing files in the flow files will be deleted
  3169.  
  3170.         The maintenance for each type of entry will only take effect if
  3171.         maintenance is enabled for the type in question in the Deletion
  3172.         configuration window.
  3173.  
  3174.         A rescan is performed before the actual maintenance.        
  3175.  
  3176.     INPUTS
  3177.         None.
  3178.  
  3179.     RETURN CODE
  3180.         0 (RC_OK) - is always returned.
  3181.  
  3182.     RESULT
  3183.         None.
  3184.  
  3185.     BUGS
  3186.         None known.
  3187.  
  3188.     SEE ALSO
  3189.         Rescan
  3190. Reflex/MatchAddress                                    Reflex/MatchAddress
  3191.  
  3192.     NAME
  3193.         MatchAddress  --  check if an address matches a pattern
  3194.  
  3195.     SYNOPSIS
  3196.         MatchAddress ADDRESS/A,PATTERN/A
  3197.  
  3198.     FUNCTION
  3199.         This command compares a specified Fido address with a specified
  3200.         pattern. The pattern can contain all valid AmigaDOS wildcards.
  3201.  
  3202.     INPUTS
  3203.         ADDRESS/A - a Fido address to match against a pattern.
  3204.         PATTERN/A - pattern to check address against.
  3205.  
  3206.     RETURN CODE
  3207.         0 (RC_OK)   - specified Fido address matches specified pattern.
  3208.         5 (RC_WARN) - specified Fido address does not match specified
  3209.                       pattern.
  3210.  
  3211.     RESULT
  3212.         None.
  3213.  
  3214.     BUGS
  3215.         None known.
  3216.  
  3217.     SEE ALSO
  3218.         MatchPollpattern
  3219. Reflex/MatchPollpattern                            Reflex/MatchPollpattern
  3220.  
  3221.     NAME
  3222.         MatchPollpattern  --  check if an address matches poll pattern
  3223.  
  3224.     SYNOPSIS
  3225.         MatchPollpattern NODE/A
  3226.  
  3227.     FUNCTION
  3228.         This command compares a specified Fido address with the poll
  3229.         pattern specified in the Mailer configuration. If there is a
  3230.         match calls to the system is allowed.
  3231.  
  3232.     INPUTS
  3233.         NODE/A - Fido address of system to check.
  3234.  
  3235.     RETURN CODE
  3236.         0 (RC_OK)   - if address matches poll pattern, i.e. calls are
  3237.                       allowed.
  3238.         5 (RC_WARN) - address didn't match poll pattern.
  3239.  
  3240.     RESULT
  3241.         None.
  3242.  
  3243.     BUGS
  3244.         None known.
  3245.  
  3246.     SEE ALSO
  3247.         FormatPollpattern, GetPollpattern, MatchAddress
  3248. Reflex/NB_GetNumNodes                                Reflex/NB_GetNumNodes
  3249.  
  3250.     NAME
  3251.         NB_GetNumNodes  --  retrieve number of nodes i Nodebook
  3252.  
  3253.     SYNOPSIS
  3254.         RESULT = NB_GetNumNodes
  3255.  
  3256.     FUNCTION
  3257.         This command will return the number of nodes currently listed in
  3258.         the Nodebook. The number is returned in RESULT.
  3259.  
  3260.     INPUTS
  3261.         None.
  3262.  
  3263.     RETURN CODE
  3264.         0 (RC_OK) - always returned.
  3265.  
  3266.     RESULT
  3267.         Number of nodes in Nodebook.
  3268.  
  3269.     BUGS
  3270.         None known.
  3271.  
  3272.     SEE ALSO
  3273.         EditNodebook, NB_IsNode, NB_NodeReq, NB_Options, NB_Phone,
  3274.         NB_Poll, NB_Port, NB_PreventCall
  3275. Reflex/NB_IsNode                                          Reflex/NB_IsNode
  3276.  
  3277.     NAME
  3278.         NB_IsNode  --  check if a node is listed in Nodebook
  3279.  
  3280.     SYNOPSIS
  3281.         NB_IsNode NODE/A
  3282.  
  3283.     FUNCTION
  3284.         This command tells you if a certain node is listed in the
  3285.         Nodebook.
  3286.  
  3287.         The command requires currently traplist.library.
  3288.  
  3289.     INPUTS
  3290.         NODE/A - Fido address of node to look for in Nodebook.
  3291.  
  3292.     RETURN CODE
  3293.         0 (RC_OK)     - if node is listed in Nodebook.
  3294.         5 (RC_WARN)   - if node isn't listed in Nodebook.
  3295.         10 (RC_ERROR) - traplist.library not available.
  3296.         10 (RC_ERROR) - specified Fido address not valid.
  3297.  
  3298.     RESULT
  3299.         None.
  3300.  
  3301.     BUGS
  3302.         None known.
  3303.  
  3304.     SEE ALSO
  3305.         EditNodebook, NB_GetNumNodes, NB_NodeReq, NB_Options, NB_Phone,
  3306.         NB_Poll, NB_Port, NB_PreventCall
  3307. Reflex/NB_NodeReq                                        Reflex/NB_NodeReq
  3308.  
  3309.     NAME
  3310.         NB_NodeReq  --  check if system will be listed in Node requester
  3311.  
  3312.     SYNOPSIS
  3313.         NB_NodeReq NODE/A
  3314.  
  3315.     FUNCTION
  3316.         This command will tell you if the system will be listed in the
  3317.         Node requester. I can't see you can have any use of this command
  3318.         to anything, but use it if you can.
  3319.  
  3320.         This command currently requires traplist.library.
  3321.  
  3322.     INPUTS
  3323.         NODE/A - Fido address of node which to check.
  3324.  
  3325.     RETURN CODE
  3326.         0 (RC_OK)     - if system not listed in Node requester.
  3327.         5 (RC_WARN)   - if system listed in Node requester.
  3328.         5 (RC_WARN)   - node not listed in Nodebook.
  3329.         10 (RC_ERROR) - traplist.library not available.
  3330.         10 (RC_ERROR) - specified Fido address not valid.
  3331.  
  3332.         Please notice, that a return code of 5 doesn't fully imply that
  3333.         the 'Node requester' checkbox in the Nodebook Editor is ticked for
  3334.         the node in question. 5 is returned too if the node isn't listed
  3335.         in the Nodebook. Therefore use NB_IsNode to check for the node in
  3336.         the Nodebook, and NB_NodeReq to check if it will be in the Node
  3337.         requester.
  3338.  
  3339.     RESULT
  3340.         None.
  3341.  
  3342.     BUGS
  3343.         None known.
  3344.  
  3345.     SEE ALSO
  3346.         EditNodebook, NB_GetNumNodes, NB_IsNode, NB_Options, NB_Phone,
  3347.         NB_Poll, NB_Port, NB_PreventCall
  3348. Reflex/NB_Options                                        Reflex/NB_Options
  3349.  
  3350.     NAME
  3351.         NB_Options  --  query alternative options for a node
  3352.  
  3353.     SYNOPSIS
  3354.         RESULT = NB_Options NODE/A
  3355.  
  3356.     FUNCTION
  3357.         This command will return alternative options for a certain node if
  3358.         such exist in the Nodebook. The alternative options will be
  3359.         returned in RESULT.
  3360.  
  3361.         This command currently requires traplist.library.
  3362.  
  3363.     INPUTS
  3364.         NODE/A - Fido address of node for which to query for alternative
  3365.                  options.
  3366.  
  3367.     RETURN CODE
  3368.         0 (RC_OK)     - if alternative options is listed for the node in
  3369.                         the Nodebook. Options is returned in RESULT.
  3370.         5 (RC_WARN)   - no alternative options is listed for the node.
  3371.         5 (RC_WARN)   - node not listed in Nodebook.
  3372.         10 (RC_ERROR) - traplist.library not available.
  3373.         10 (RC_ERROR) - specified Fido address not valid.
  3374.  
  3375.     RESULT
  3376.         Alternative options for the node.
  3377.  
  3378.     BUGS
  3379.         None known.
  3380.  
  3381.     SEE ALSO
  3382.         EditNodebook, NB_GetNumNodes, NB_IsNode, NB_NodeReq, NB_Phone,
  3383.         NB_Poll, NB_Port, NB_PreventCall
  3384. Reflex/NB_Phone                                            Reflex/NB_Phone
  3385.  
  3386.     NAME
  3387.         NB_Phone  --  query alternative phone number for a node
  3388.  
  3389.     SYNOPSIS
  3390.         RESULT = NB_Phone NODE/A
  3391.  
  3392.     FUNCTION
  3393.         This command will return an alternative phone number for a certain
  3394.         node if such exist in the Nodebook. The alternative phone number
  3395.         will be returned in RESULT.
  3396.  
  3397.         This command currently requires traplist.library.
  3398.  
  3399.     INPUTS
  3400.         NODE/A - Fido address of node for which to query for an
  3401.                  alternative phone number.
  3402.  
  3403.     RETURN CODE
  3404.         0 (RC_OK)     - if an alternative phone number is listed for the
  3405.                         node in the Nodebook. The phone number is returned
  3406.                         in RESULT.
  3407.         5 (RC_WARN)   - no alternative phone number is listed for the
  3408.                         node.
  3409.         5 (RC_WARN)   - node not listed in Nodebook.
  3410.         10 (RC_ERROR) - traplist.library not available.
  3411.         10 (RC_ERROR) - specified Fido address not valid.
  3412.  
  3413.     RESULT
  3414.         Alternative phone number for the node.
  3415.  
  3416.     BUGS
  3417.         None known.
  3418.  
  3419.     SEE ALSO
  3420.         EditNodebook, NB_GetNumNodes, NB_IsNode, NB_NodeReq, NB_Options,
  3421.         NB_Poll, NB_Port, NB_PreventCall
  3422. Reflex/NB_Poll                                              Reflex/NB_Poll
  3423.  
  3424.     NAME
  3425.         NB_Poll  --  query alternative address for a node
  3426.  
  3427.     SYNOPSIS
  3428.         RESULT = NB_Poll NODE/A
  3429.  
  3430.     FUNCTION
  3431.         This command will return an alternative Fido address for a certain
  3432.         node if such exist in the Nodebook. The alternative poll address
  3433.         will be returned in RESULT.
  3434.  
  3435.         This command currently requires traplist.library.
  3436.  
  3437.     INPUTS
  3438.         NODE/A - Fido address of node for which to query for an
  3439.                  alternative Fido address.
  3440.  
  3441.     RETURN CODE
  3442.         0 (RC_OK)     - if an alternative address is listed for the node
  3443.                         in the Nodebook. Address is returned in RESULT.
  3444.         5 (RC_WARN)   - no alternative poll address is listed for the
  3445.                         node.
  3446.         5 (RC_WARN)   - node not listed in Nodebook.
  3447.         10 (RC_ERROR) - traplist.library not available.
  3448.         10 (RC_ERROR) - specified Fido address not valid.
  3449.  
  3450.     RESULT
  3451.         Alternative poll address for the node.
  3452.  
  3453.     BUGS
  3454.         None known.
  3455.  
  3456.     SEE ALSO
  3457.         EditNodebook, NB_GetNumNodes, NB_IsNode, NB_NodeReq, NB_Options,
  3458.         NB_Phone, NB_Port, NB_PreventCall
  3459. Reflex/NB_Port                                              Reflex/NB_Port
  3460.  
  3461.     NAME
  3462.         NB_Port  --  query alternative port for a node
  3463.  
  3464.     SYNOPSIS
  3465.         RESULT = NB_Port NODE/A
  3466.  
  3467.     FUNCTION
  3468.         This command will return an alternative port for a certain node
  3469.         if such exist in the Nodebook. The alternative port will be
  3470.         returned in RESULT.
  3471.  
  3472.         This command currently requires traplist.library.
  3473.  
  3474.     INPUTS
  3475.         NODE/A - Fido address of node for which to query for an
  3476.                  alternative port.
  3477.  
  3478.     RETURN CODE
  3479.         0 (RC_OK)     - if an alternative port is listed for the node in
  3480.                         the Nodebook. Port is returned in RESULT.
  3481.         5 (RC_WARN)   - no alternative port is listed for the node.
  3482.         5 (RC_WARN)   - node not listed in Nodebook.
  3483.         10 (RC_ERROR) - traplist.library not available.
  3484.         10 (RC_ERROR) - specified Fido address not valid.
  3485.  
  3486.     RESULT
  3487.         Alternative port for the node.
  3488.  
  3489.     BUGS
  3490.         None known.
  3491.  
  3492.     SEE ALSO
  3493.         EditNodebook, NB_GetNumNodes, NB_IsNode, NB_NodeReq, NB_Options,
  3494.         NB_Phone, NB_Poll, NB_PreventCall
  3495. Reflex/NB_PreventCall                                Reflex/NB_PreventCall
  3496.  
  3497.     NAME
  3498.         NB_PreventCall  --  check if call to system is allowed
  3499.  
  3500.     SYNOPSIS
  3501.         NB_PreventCall NODE/A
  3502.  
  3503.     FUNCTION
  3504.         This command will tell you if calls to the system is allowed.
  3505.  
  3506.         This command currently requires traplist.library.
  3507.  
  3508.     INPUTS
  3509.         NODE/A - Fido address of node which to check.
  3510.  
  3511.     RETURN CODE
  3512.         0 (RC_OK)     - if calls to this system is cancelled.
  3513.         5 (RC_WARN)   - if calls to this system is allowed.
  3514.         5 (RC_WARN)   - node not listed in Nodebook.
  3515.         10 (RC_ERROR) - traplist.library not available.
  3516.         10 (RC_ERROR) - specified Fido address not valid.
  3517.  
  3518.         Please notice, that a return code of 5 doesn't fully imply that
  3519.         the 'Prevent calls' checkbox in the Nodebook Editor isn't ticked
  3520.         for the node in question. 5 is returned too if the node isn't
  3521.         listed in the Nodebook. Therefore use NB_IsNode to check for the
  3522.         node in the Nodebook, and NB_PreventCall to check if calls to the
  3523.         system is allowed.
  3524.  
  3525.     RESULT
  3526.         None.
  3527.  
  3528.     BUGS
  3529.         None known.
  3530.  
  3531.     SEE ALSO
  3532.         EditNodebook, NB_GetNumNodes, NB_IsNode, NB_NodeReq, NB_Options,
  3533.         NB_Phone, NB_Poll, NB_Port
  3534. Reflex/NextEntry                                          Reflex/NextEntry
  3535.  
  3536.     NAME
  3537.         NextEntry  --  move outbound list pointer to next entry
  3538.  
  3539.     SYNOPSIS
  3540.         NextEntry
  3541.  
  3542.     FUNCTION
  3543.         This command will move the outbound list pointer to the next entry
  3544.         in the outbound list.
  3545.  
  3546.     INPUTS
  3547.         None.
  3548.  
  3549.     RETURN CODE
  3550.         0 (RC_OK)     - if outbound list pointer was moved to the next
  3551.                         entry in the outbound list.
  3552.         5 (RC_WARN)   - if the outbound list pointer was on the last entry
  3553.                         in in the outbound list.
  3554.         10 (RC_ERROR) - if the outbound list is empty.
  3555.  
  3556.     RESULT
  3557.         None.
  3558.  
  3559.     BUGS
  3560.         None known.
  3561.  
  3562.     SEE ALSO
  3563.         FindNextNode, FindNode, FirstEmpty, FirstEntry, FirstNode,
  3564.         FirstOrphan, LastEntry, NextNode, NextNodeEntry, PrevEntry,
  3565.         PrevNode, PrevNodeEntry
  3566. Reflex/NextNode                                            Reflex/NextNode
  3567.  
  3568.     NAME
  3569.         NextNode  --  move outbound list pointer to next entry in outbound
  3570.                       list with Fido address different from current
  3571.  
  3572.     SYNOPSIS
  3573.         NextNode
  3574.  
  3575.     FUNCTION
  3576.         This command will move the outbound list pointer to the next entry
  3577.         in the outbound list with a Fido address different from the Fido
  3578.         address of the current entry.
  3579.  
  3580.         In other words this command will skip all entries with the same
  3581.         Fido address as the current entry.
  3582.  
  3583.         The command will not move the outbound list pointer to an orphan
  3584.         or empty file.
  3585.  
  3586.     INPUTS
  3587.         None.
  3588.  
  3589.     RETURN CODE
  3590.         0 (RC_OK)     - if the outbound list pointer was moved to the next
  3591.                         entry in the outbound list with a Fido address
  3592.                         different from the current.
  3593.         5 (RC_WARN)   - if no succeeding entry in the outbound list has got
  3594.                         a Fido address different the current.
  3595.         10 (RC_ERROR) - if the outbound list is empty.
  3596.  
  3597.     RESULT
  3598.         None.
  3599.  
  3600.     BUGS
  3601.         None known.
  3602.  
  3603.     SEE ALSO
  3604.         FindNextNode, FindNode, FirstEmpty, FirstEntry, FirstNode,
  3605.         FirstOrphan, LastEntry, NextEntry, NextNodeEntry, PrevEntry,
  3606.         PrevNode, PrevNodeEntry
  3607. Reflex/NextNodeEntry                                  Reflex/NextNodeEntry
  3608.  
  3609.     NAME
  3610.         NextNodeEntry  --  move outbound list pointer to next entry with
  3611.                            same Fido address
  3612.  
  3613.     SYNOPSIS
  3614.         NextNodeEntry
  3615.  
  3616.     FUNCTION
  3617.         This command will move the outbound list pointer to the next entry
  3618.         in the outbound list with the same Fido address as the current
  3619.         entry.
  3620.  
  3621.         This command can also be used to move to the next empty file or
  3622.         to the next orphan file.
  3623.  
  3624.     INPUTS
  3625.         None.
  3626.  
  3627.     RETURN CODE
  3628.         0 (RC_OK)     - if the outbound list pointer was moved to the next
  3629.                         entry with the same Fido address as the current.
  3630.         5 (RC_WARN)   - if the succeding entry in the outbound list
  3631.                         doesn't have the same Fido address.
  3632.         5 (RC_WARN)   - if the current entry already is the last entry in
  3633.                         the outbound list.
  3634.         10 (RC_ERROR) - if the outbound list is empty.
  3635.  
  3636.     RESULT
  3637.         None.
  3638.  
  3639.     BUGS
  3640.         None known.
  3641.  
  3642.     SEE ALSO
  3643.         FindNextNode, FindNode, FirstEmpty, FirstEntry, FirstNode,
  3644.         FirstOrphan, LastEntry, NextEntry, NextNode, PrevEntry, PrevNode,
  3645.         PrevNodeEntry
  3646. Reflex/OpenProgress                                    Reflex/OpenProgress
  3647.  
  3648.     NAME
  3649.         OpenProgress  --  open progress requester
  3650.  
  3651.     SYNOPSIS
  3652.         RESULT = OpenProgress TITLE/K,TEXT/A,MINTEXT/A,MAXTEXT/A,MAX/N/A,
  3653.                               CURRENT/N/A
  3654.  
  3655.     FUNCTION
  3656.         This command opens a progress requester. The progress requester
  3657.         is opened asynchronously, and you address it using the command
  3658.         UpdateProgress to update the progress requester, and the command
  3659.         CloseProgress to close the progress requester. To address a
  3660.         progress requester you will need a key.
  3661.  
  3662.         A short text will be put above the progress bar (TEXT/A), and a
  3663.         minimum and maximum text will be put below the progress bar to
  3664.         the right and left, respectively (MINTEXT/A and MAXTEXT/A,
  3665.         respectively).
  3666.  
  3667.         A progress requester always starts at zero and ends at a maximum
  3668.         value specified by you (MAX/N/A).
  3669.  
  3670.         An empty progress requester has got a current value of zero. The
  3671.         initial value is specified with the CURRENT/N/A argument. When
  3672.         the progress requester opens it will be updated to this value.
  3673.  
  3674.         Optionally you can change the window title of the requester using
  3675.         the TITLE keyword.
  3676.  
  3677.         As mentioned before to address a progress requester you will need
  3678.         a key, which the OpenProgress command returns in RESULT. This key
  3679.         is needed for ALL communication with the progress requester. If
  3680.         you loose this key you will not be able to address the progress
  3681.         requester and it will be left hanging when your script ends.
  3682.  
  3683.         It is your job to close any progress requesters that you have
  3684.         opened. Use of ARexx 'onerror' is recommended for this. A hanging
  3685.         progress requester when your script have ended is the proof of
  3686.         a badly written ARexx script.
  3687.  
  3688.         Leftover progress requesters will be closed when Reflex quits,
  3689.         but this is not the right way to close progress requesters. This
  3690.         is only mentioned for programmers that might end with a hanging
  3691.         progress requester when developing ARexx scripts.
  3692.  
  3693.         Multiple progress requesters can be opened at the same time.
  3694.  
  3695.     INPUTS
  3696.         The examples are all taken from the progress requester that opens
  3697.         when Reflex scans the outbound directory.
  3698.  
  3699.         TITLE/K     - window title. Defaults to 'Reflex message'.
  3700.         TEXT/A      - short one-line text to display above the progress
  3701.                       bar; e.g. "Scanning outbound".
  3702.         MINTEXT/A   - Minimum text to be displayed to the left under the
  3703.                       progress bar. This text does not have anything to
  3704.                       do with the minimum value the requester displays; it
  3705.                       could be "0 %" or "Start". The scanning outbound
  3706.                       progress requester has got "1" for MINTEXT/A.
  3707.         MAXTEXT/A   - Maximum text to be displayed to the right under the
  3708.                       progress bar. This text does not have anything to
  3709.                       do with the maximum value the requester displays; it
  3710.                       could be "100 %" or "End"; e.g. the number of files
  3711.                       in the outbound directory - converted to a string.
  3712.         MAX/N/A     - The maximum value the progress requester shall
  3713.                       display; i.e. the progress requester is from zero to
  3714.                       this value; in the scanning outbound progress
  3715.                       requester case this is the number of files in the
  3716.                       outbound directory. This value must be greater than
  3717.                       zero.
  3718.         CURRENT/N/A - This is the current value of the progress requester.
  3719.                       When Reflex opens the progress requester the
  3720.                       progress will be updated to this value; the scanning
  3721.                       outbound progress requester opens with this value
  3722.                       set to 1.
  3723.  
  3724.     RETURN CODE
  3725.         0 (RC_OK) - is always returned. Examine RESULT to see if a
  3726.                     progress requester was opened.
  3727.  
  3728.     RESULT
  3729.         A progress requester identifier key. This key is needed for all
  3730.         communication with the progress requester.
  3731.  
  3732.         This key is a number and is this number zero Reflex didn't succeed
  3733.         in opening a progress requester. It will be alright to pass this
  3734.         zero value to UpdateProgress and CloseProgress.
  3735.  
  3736.     EXAMPLE
  3737.         This will probably be the only example. This short ARexx code
  3738.         opens two progress requesters, updates them, and finally closes
  3739.         them.
  3740.  
  3741.             OPENPROGRESS '"Progress requester test" "0" "100" 200 0'
  3742.             progress = result
  3743.  
  3744.             OPENPROGRESS '"Progress requester 2" "0" "50" 100 0'
  3745.             progress2 = result
  3746.  
  3747.             i = 0
  3748.  
  3749.             DO WHILE (i < 200)
  3750.                 CALL DELAY(2)
  3751.                 i = i + 1
  3752.                 UPDATEPROGRESS progress i
  3753.                 IF (i < 100) THEN DO
  3754.                     UPDATEPROGRESS progress2 i
  3755.                 END
  3756.                 IF (i = 100) THEN DO
  3757.                     CLOSEPROGRESS progress2
  3758.                 END
  3759.             END
  3760.  
  3761.             CLOSEPROGRESS progress
  3762.  
  3763.         The script uses rexxsupport.library for the DELAY() function as
  3764.         far as I know.
  3765.  
  3766.     BUGS
  3767.         It seems EasyREXX doesn't handle strings with spaces too well.
  3768.         A string like "Scanning outbound" doesn't work unless I surround
  3769.         all arguments in single quotes. I don't really know how to use
  3770.         ARexx, so EasyREXX might do it correctly. Just do it like the
  3771.         example above and it works. A hard space (ASCII 160) could be
  3772.         used instead of normal spaces (ASCII 32) I guess.
  3773.  
  3774.     SEE ALSO
  3775.         CloseProgress, UpdateProgress
  3776. Reflex/Poll                                                    Reflex/Poll
  3777.  
  3778.     NAME
  3779.         Poll  --  poll a system
  3780.  
  3781.     SYNOPSIS
  3782.         Poll NODE/A,SYNC/S,POLLCOMMAND/K
  3783.  
  3784.     FUNCTION
  3785.         This system will poll another system. This requires a poll command
  3786.         to be specified in the Mailer configuration.
  3787.  
  3788.         Please notice, that Reflex might prevent certain calls. Calls to
  3789.         Fido address that doesn't match the poll pattern are cancelled,
  3790.         and calls to certain systems can be prevented according to certain
  3791.         Nodebook settings.
  3792.  
  3793.         The poll command is executed asynchronously. Specifying the SYNC
  3794.         switch will execute the poll command synchronously.
  3795.  
  3796.         Another poll command can be specified to be used instead of the
  3797.         one specified in the Mailer configuration.
  3798.  
  3799.     INPUTS
  3800.         NODE/A        - Fido address of system to poll. This can be 'BOSS'
  3801.                         if your mailer supports this.
  3802.         SYNC/S        - execute poll command synchronously.
  3803.         POLLCOMMAND/K - another poll command to use instead of the one
  3804.                         specified in the Mailer configuration.
  3805.  
  3806.     RETURN CODE
  3807.         0 (RC_OK)     - if Reflex tried to poll the other system.
  3808.         10 (RC_ERROR) - if the specified Fido address is invalid (requires
  3809.                         traplist.library).
  3810.  
  3811.     RESULT
  3812.         None.
  3813.  
  3814.     BUGS
  3815.         None known.
  3816.  
  3817.     SEE ALSO
  3818.         FormatPollcommand, GetPollcommand, PollEntry
  3819. Reflex/PollEntry                                          Reflex/PollEntry
  3820.  
  3821.     NAME
  3822.         PollEntry  --  poll system of current entry
  3823.  
  3824.     SYNOPSIS
  3825.         PollEntry SYNC/S,POLLCOMMAND/K
  3826.  
  3827.     FUNCTION
  3828.         This system will poll the system of the current entry. This
  3829.         requires a poll command to be specified in the Mailer
  3830.         configuration.
  3831.  
  3832.         Please notice, that Reflex might prevent certain calls. Calls to
  3833.         Fido address that doesn't match the poll pattern are cancelled,
  3834.         and calls to certain systems can be prevented according to certain
  3835.         Nodebook settings.
  3836.  
  3837.         The poll command is executed asynchronously. Specifying the SYNC
  3838.         switch will execute the poll command synchronously.
  3839.  
  3840.         Another poll command can be specified to be used instead of the
  3841.         one specified in the Mailer configuration.
  3842.  
  3843.     INPUTS
  3844.         SYNC/S        - execute poll command synchronously.
  3845.         POLLCOMMAND/K - another poll command to use instead of the one
  3846.                         specified in the Mailer configuration.
  3847.  
  3848.     RETURN CODE
  3849.         0 (RC_OK) - is returned.
  3850.  
  3851.     RESULT
  3852.         None.
  3853.  
  3854.     BUGS
  3855.         None known.
  3856.  
  3857.     NOTE
  3858.         The main window 'Poll' gadget is disabled when the current entry
  3859.         in the listview is a request at your own system, i.e. you can't
  3860.         call the system. The PollEntry command can poll the system of the
  3861.         current entry even if its a request at your system.
  3862.  
  3863.     SEE ALSO
  3864.         FormatPollcommand, GetPollcommand, Poll
  3865. Reflex/PrevEntry                                          Reflex/PrevEntry
  3866.  
  3867.     NAME
  3868.         PrevEntry  --  move outbound list pointer to previous entry
  3869.  
  3870.     SYNOPSIS
  3871.         PrevEntry
  3872.  
  3873.     FUNCTION
  3874.         This command moves the outbound list pointer to the previous entry
  3875.         in the outbound list.
  3876.  
  3877.     INPUTS
  3878.         None.
  3879.  
  3880.     RETURN CODE
  3881.         0 (RC_OK)     - if the outbound list pointer was moved to the
  3882.                         previous entry in the outbound list.
  3883.         5 (RC_WARN)   - if the outbound list pointer was on the first
  3884.                         entry in the outbound list.
  3885.         10 (RC_ERROR) - if the outbound list is empty.
  3886.  
  3887.     RESULT
  3888.         None.
  3889.  
  3890.     BUGS
  3891.         None known.
  3892.  
  3893.     SEE ALSO
  3894.         FindNextNode, FindNode, FirstEmpty, FirstEntry, FirstNode,
  3895.         FirstOrphan, LastEntry, NextEntry, NextNode, NextNodeEntry,
  3896.         PrevNode, PrevNodeEntry
  3897. Reflex/PrevNode                                            Reflex/PrevNode
  3898.  
  3899.     NAME
  3900.         PrevNode  --  move outbound list pointer to first preceding entry
  3901.                       with Fido address different from current
  3902.  
  3903.     SYNOPSIS
  3904.         PrevNode
  3905.  
  3906.     FUNCTION
  3907.         This command moves the outbound list pointer to the first
  3908.         preceding entry with a Fido address different from the Fido
  3909.         address of the current entry.
  3910.  
  3911.         With "first entry" is meant the first entry in the outbound list
  3912.         with the other Fido address. Is the outbound list pointer placed
  3913.         as shown below:
  3914.  
  3915.              <N1> <N1> <N1> <N2> <N2> <N2> <N2>
  3916.                                        ^
  3917.                                        |
  3918.  
  3919.         where <N1> and <N2> are entries with different Fido addresses.
  3920.         Use of PrevNode will result in the following placement of the
  3921.         outbound list pointer:
  3922.  
  3923.              <N1> <N1> <N1> <N2> <N2> <N2> <N2>
  3924.               ^
  3925.               |
  3926.  
  3927.         In other words the command will go back and skip all entries with
  3928.         a Fido address the same as the current entry and in addition skip
  3929.         to the first entry with a Fido address different from the current.
  3930.  
  3931.         The command will also skip orphan and empty files.
  3932.  
  3933.     INPUTS
  3934.         None.
  3935.  
  3936.     RETURN CODE
  3937.         0 (RC_OK)     - if the outbound list pointer was moved to the
  3938.                         first preceding entry in the outbound list with a
  3939.                         Fido address different from the current.
  3940.         5 (RC_WARN)   - if there was no preceding entry with a Fido
  3941.                         address different from the current. The outbound
  3942.                         list pointer will not have moved.
  3943.         10 (RC_ERROR) - if the outbound list is empty.
  3944.  
  3945.     RESULT
  3946.         None.
  3947.  
  3948.     BUGS
  3949.         None known.
  3950.  
  3951.     SEE ALSO
  3952.         FindNextNode, FindNode, FirstEmpty, FirstEntry, FirstNode,
  3953.         FirstOrphan, LastEntry, NextEntry, NextNode, NextNodeEntry,
  3954.         PrevEntry, PrevNodeEntry.
  3955. Reflex/PrevNodeEntry                                  Reflex/PrevNodeEntry
  3956.  
  3957.     NAME
  3958.         PrevNodeEntry  --  move outbound list pointer to previous entry
  3959.                            with same Fido address
  3960.  
  3961.     SYNOPSIS
  3962.         PrevNodeEntry
  3963.  
  3964.     FUNCTION
  3965.         This command will move the outbound list pointer to the previous
  3966.         entry in the outbound list with the same Fido address as the
  3967.         current entry.
  3968.  
  3969.         This command can also be used to move to the previous empty file
  3970.         or to the previous orphan file.
  3971.  
  3972.     INPUTS
  3973.         None.
  3974.  
  3975.     RETURN CODE
  3976.         0 (RC_OK)     - if the outbound list pointer was move to previous
  3977.                         entry with the same Fido address.
  3978.         5 (RC_WARN)   - if the previous entry didn't have the same Fido
  3979.                         address.
  3980.         5 (RC_WARN)   - if the current entry already is the first entry in
  3981.                         the outbound list.
  3982.         10 (RC_ERROR) - if the outbound list is empty.
  3983.  
  3984.     RESULT
  3985.         None.
  3986.  
  3987.     BUGS
  3988.         None known.
  3989.  
  3990.     SEE ALSO
  3991.         FindNextNode, FindNode, FirstEmpty, FirstEntry, FirstNode,
  3992.         FirstOrphan, LastEntry, NextEntry, NextNode, NextNodeEntry,
  3993.         PrevEntry, PrevNode
  3994. Reflex/PrintList                                          Reflex/PrintList
  3995.  
  3996.     NAME
  3997.         PrintList  --  print contents of outbound list to printer
  3998.  
  3999.     SYNOPSIS
  4000.         PrintList
  4001.  
  4002.     FUNCTION
  4003.         This command will print the contents of the outbound list as
  4004.         displayed in the listview to the printer (PRT:)
  4005.  
  4006.     INPUTS
  4007.         None.
  4008.  
  4009.     RETURN CODE
  4010.         0 (RC_OK) - always returned.
  4011.  
  4012.     RESULT
  4013.         None.
  4014.  
  4015.     BUGS
  4016.         None known.
  4017.  
  4018.     SEE ALSO
  4019. Reflex/QueryOwnership                                Reflex/QueryOwnership
  4020.  
  4021.     NAME
  4022.         QueryOwnership  --  query ownership state of ARexx port
  4023.  
  4024.     SYNOPSIS
  4025.         QueryOwnership LOCK/S
  4026.  
  4027.     FUNCTION
  4028.         This command will tell you if Reflex is ARexx locked by another
  4029.         ARexx script or not. This is the only command that you actually
  4030.         can use if the ARexx port is locked by another script.
  4031.  
  4032.         If you by using QueryOwnership learns that nobody currently has
  4033.         got ARexx ownership over Reflex' ARexx port there is no guarantee
  4034.         that a LockARexx immediately after will succeed; another script
  4035.         might have ARexx locked Reflex between the two commands.
  4036.  
  4037.         Therefore use the LOCK switch which will give you ownership over
  4038.         the ARexx port if it was free. Please refer to LockARexx for more
  4039.         information about ARexx locking. Do you become ownership over
  4040.         Reflex' ARexx port this way, you must match this command with an
  4041.         UnlockARexx before the script ends. Use of ARexx 'onerror' is
  4042.         highly recommended.
  4043.  
  4044.         Do you learn that another script has ARexx locked Reflex you can
  4045.         either wait a few seconds and query for ownership again or exit
  4046.         you script. The choice depends on you script.
  4047.  
  4048.     INPUTS
  4049.         LOCK/S - if the ARexx port was free you will become ownership over
  4050.                  the port.
  4051.  
  4052.     RETURN CODE
  4053.         0 (RC_OK)   - if Reflex wasn't ARexx locked by another script. If
  4054.                       you had specified the LOCK switch you will now have
  4055.                       ownership over Reflex' ARexx port.
  4056.         5 (RC_WARN) - another script has got ownership over Reflex' ARexx
  4057.                       port. Wait a few seconds and query again - or exit.
  4058.  
  4059.     RESULT
  4060.         None.
  4061.  
  4062.     BUGS
  4063.         None known.
  4064.  
  4065.     SEE ALSO
  4066.         LockARexx, LockGUI, UnlockARexx
  4067. Reflex/Quit                                                    Reflex/Quit
  4068.  
  4069.     NAME
  4070.         Quit  --  quit Reflex
  4071.  
  4072.     SYNOPSIS
  4073.         Quit NOREQ/S,NOSAVE/S
  4074.  
  4075.     FUNCTION
  4076.         This command simply quits Reflex. With no switches set Reflex
  4077.         will prompt the user with a "Save settings?" requester if the
  4078.         settings have changed.
  4079.  
  4080.         The NOREQ switch will suppress this requester. Reflex will default
  4081.         save the settings, unless the NOSAVE switch is specified
  4082.  
  4083.     INPUTS
  4084.         NOREQ/S  - suppress confirmation requester.
  4085.         NOSAVE/S - suppress default saving of settings if requester is
  4086.                    suppressed. Using both the NOREQ and NOSAVE switches
  4087.                    means that Reflex can quit without saving changed
  4088.                    settings.
  4089.  
  4090.     RETURN CODE
  4091.         0 (RC_OK) - is always returned.
  4092.  
  4093.     RESULT
  4094.         None.
  4095.  
  4096.     BUGS
  4097.         None known.
  4098.  
  4099.     SEE ALSO
  4100. Reflex/RequestAddress                                Reflex/RequestAddress
  4101.  
  4102.     NAME
  4103.         RequestAddress  --  request user for a Fido address
  4104.  
  4105.     SYNOPSIS
  4106.         RESULT = RequestAddress ADDRESS,TITLE/K,TEXT/K
  4107.  
  4108.     FUNCTION
  4109.         This command will bring forth the Address requester for the user
  4110.         to select a Fido address.
  4111.  
  4112.         Default the Address requester will open with no address, but
  4113.         specifying Fido address for the Address requester to open with is
  4114.         possible.
  4115.  
  4116.         Window title and a short text to display in the top of the
  4117.         requester can be specified.
  4118.  
  4119.         The selected address is returned in RESULT.
  4120.  
  4121.     INPUTS
  4122.         ADDRESS - optional Fido address for the Address requester to open
  4123.                   with.
  4124.         TITLE/K - window title. Defaults to 'Reflex message'.
  4125.         TEXT/K  - short one-line text to display in the top of the
  4126.                   requester. Defaults to 'Enter address'.
  4127.  
  4128.     RETURN CODE
  4129.         The user selected Fido address, e.g. "2:238/127.0".
  4130.  
  4131.     RESULT
  4132.         0 (RC_OK)     - user selected a Fido address in the Address
  4133.                         requester. The selected Fido address is available
  4134.                         in RESULT.
  4135.         5 (RC_WARN)   - user cancelled the Address requester.
  4136.         10 (RC_ERROR) - (only if an open address is specified) the
  4137.                         specified Fido address is invalid.
  4138.  
  4139.     BUGS
  4140.         None known.
  4141.  
  4142.     SEE ALSO
  4143.         ChangeEntryAddress, GetEntryAddress, RequestNode, SetEntryAddress
  4144. Reflex/RequestAttach                                  Reflex/RequestAttach
  4145.  
  4146.     NAME
  4147.         RequestAttach  --  open Attach requester
  4148.  
  4149.     SYNOPSIS
  4150.         RequestAttach TITLE/K,NODE
  4151.  
  4152.     FUNCTION
  4153.         This command will bring forth the Attach requester for the user
  4154.         to attach files. When you use the RequestAttach command you should
  4155.         notice two things
  4156.  
  4157.         - after this command has succeeded the outbound list will contain
  4158.           more entrires than it did before if the user attached some
  4159.           files. To obtain the number of files that was attached you can
  4160.           use the GetNumEntries command before and after you executed the
  4161.           RequestAttach command because the difference between these two
  4162.           results is the number of files attached.
  4163.  
  4164.         - the new entries (i.e. the new attached files) will be located at
  4165.           the end of the list; i.e. it will be the last entries in the
  4166.           outbound list. You can use SortOutboundList to sort the list and
  4167.           thereby move the new entries to their correct position in the
  4168.           outbound list if needed.
  4169.  
  4170.         An optional window title can be specified using the keyword TITLE.
  4171.  
  4172.     INPUTS
  4173.         TITLE/K - optional window title. Defaults to 'Reflex <ver> File
  4174.                   attach'.
  4175.         NODE    - optional Fido address to display in 'Node' string gadget
  4176.                   when the requester opens.
  4177.  
  4178.     RETURN CODE
  4179.         0 (RC_OK)     - user attached some files.
  4180.         5 (RC_WARN)   - no files were attached.
  4181.         10 (RC_ERROR) - (only with NODE) Fido address invalid.
  4182.  
  4183.     RESULT
  4184.         None.
  4185.  
  4186.     BUGS
  4187.         None known.
  4188.  
  4189.     SEE ALSO
  4190.         Attach, SortOutboundList
  4191. Reflex/RequestFile                                      Reflex/RequestFile
  4192.  
  4193.     NAME
  4194.         RequestFile  --  open file requester
  4195.  
  4196.     SYNOPSIS
  4197.         RESULT = RequestFile TITLE/K,PATH/K,FILE/K,PATTERN/K
  4198.  
  4199.     FUNCTION
  4200.         This command opens a file requester (currently a ReqTools file
  4201.         requester) for the user to select a file.
  4202.  
  4203.         You can specify a window title, a path to open the requester in,
  4204.         a filename to be displayed in the file gadget, and a pattern.
  4205.  
  4206.         The selected file - if any - is returned in RESULT.
  4207.  
  4208.     INPUTS
  4209.         TITLE/K   - a window title for the file requester. Defaults to
  4210.                     'Select file'.
  4211.         PATH/K    - directory to open file requester in. Defaults to
  4212.                     current directory.
  4213.         FILE/K    - filename to display in file gadget. Defaults to none.
  4214.         PATTERN/K - pattern to match file against.
  4215.  
  4216.     RETURN CODE
  4217.         0 (RC_OK)   - if the user selected a file. The filename will be
  4218.                       returned in RESULT.
  4219.         5 (RC_WARN) - user selected 'Cancel'.
  4220.  
  4221.     RESULT
  4222.         Filename of selected file, incl. full path.
  4223.  
  4224.     BUGS
  4225.         None known.
  4226.  
  4227.     SEE ALSO
  4228.         RequestPath
  4229. Reflex/RequestFreq                                      Reflex/RequestFreq
  4230.  
  4231.     NAME
  4232.         RequestFreq  --  open Freq requester
  4233.  
  4234.     SYNOPSIS
  4235.         RequestFreq NODE
  4236.  
  4237.     FUNCTION
  4238.         This command will bring forth the Freq requester for the user to
  4239.         request files. When you use the RequestFreq command you should
  4240.         notice two things:
  4241.  
  4242.         - after this command has succeeded the outbound list will contain
  4243.           more entrires than it did before if the user requested some
  4244.           files. To obtain the number of files that was requested you can
  4245.           use the GetNumEntries command before and after you executed the
  4246.           RequestFreq command because the difference between these two
  4247.           results is the number of files requested.
  4248.  
  4249.         - the new entries (i.e. the new file requests) will be located at
  4250.           the end of the list; i.e. it will be the last entries in the
  4251.           outbound list. You can use SortOutboundList to sort the list and
  4252.           thereby move the new entries to their correct position in the
  4253.           outbound list if needed.
  4254.  
  4255.         Optionally a window title can be specified.
  4256.  
  4257.     INPUTS
  4258.         TITLE/K - optional window title. Defaults to 'Reflex <ver> File
  4259.                   request'.
  4260.         NODE    - optional Fido address to display in 'Node' string gadget
  4261.                   when the requester opens.
  4262.  
  4263.     RETURN CODE
  4264.         0 (RC_OK)     - user requested some files.
  4265.         5 (RC_WARN)   - no files were requested.
  4266.         10 (RC_ERROR) - (only with NODE) Fido address invalid.
  4267.  
  4268.     RESULT
  4269.         None.
  4270.  
  4271.     BUGS
  4272.         None known.
  4273.  
  4274.     SEE ALSO
  4275.         Freq, SortOutboundList
  4276. Reflex/RequestNode                                      Reflex/RequestNode
  4277.  
  4278.     NAME
  4279.         RequestNode  --  request user for a node selected from a group
  4280.                          of nodes
  4281.  
  4282.     SYNOPSIS
  4283.         RESULT = RequestNode TITLE/K,TEXT/K
  4284.  
  4285.     FUNCTION
  4286.         This command opens the Node requester and prompt the user to
  4287.         select a node among a group of nodes. The group of nodes consist
  4288.         of those that have the 'Node requester' checkbox ticked in the
  4289.         Nodebook.
  4290.  
  4291.         A window title and a short text to be display above the listview
  4292.         can be specified.
  4293.  
  4294.         The Fido address of the selected node is returned in RESULT.
  4295.  
  4296.     INPUTS
  4297.         TITLE/K - window title. Defaults to 'Reflex message'.
  4298.         TEXT/K  - short one-line text to be displayed above the listview.
  4299.                   Defaults to 'Select node'.
  4300.  
  4301.     RETURN CODE
  4302.         0 (RC_OK)     - the user selected a node. The Fido address of the
  4303.                         node is avaiable in RESULT.
  4304.         5 (RC_WARN)   - user cancelled Node requester.
  4305.         10 (RC_ERROR) - no nodes is listed in the Node requester, i.e. no
  4306.                         nodes have the 'Node requester' checkbox ticked in
  4307.                         the Nodebook.
  4308.  
  4309.     RESULT
  4310.         The Fido address of the selected node.
  4311.  
  4312.     BUGS
  4313.         None known.
  4314.  
  4315.     SEE ALSO
  4316.         RequestAddress
  4317. Reflex/RequestNotify                                  Reflex/RequestNotify
  4318.  
  4319.     NAME
  4320.         RequestNotify  --  open notification requester
  4321.  
  4322.     SYNOPSIS
  4323.         RequestNotify TITLE/K,PROMPT/A
  4324.  
  4325.     FUNCTION
  4326.         This function opens a simple requester for you to notify the
  4327.         user. You can specify the window title and naturally the text
  4328.         to display in the requester.
  4329.  
  4330.         The only gadget is a (localized) 'Ok' gadget.
  4331.  
  4332.     INPUTS
  4333.         TITLE/K  - window title. Defaults to 'Reflex message'.
  4334.         PROMPT/A - text to display in the requester.
  4335.  
  4336.     RETURN CODE
  4337.         0 (RC_OK) - always returned.
  4338.  
  4339.     RESULT
  4340.         None.
  4341.  
  4342.     BUGS
  4343.         None known.
  4344.  
  4345.     SEE ALSO
  4346.         RequestResponse
  4347. Reflex/RequestPath                                      Reflex/RequestPath
  4348.  
  4349.     NAME
  4350.         RESULT = RequestPath  --  open directory requester
  4351.  
  4352.     SYNOPSIS
  4353.         RequestPath TITLE/K,PATH/K
  4354.  
  4355.     FUNCTION
  4356.         This function opens a directory requester (currently a ReqTools
  4357.         directory requester) for the user to select a path.
  4358.  
  4359.         You can specify the window title and the path to open the
  4360.         requester in.
  4361.  
  4362.         If the user selected a path it will be available in RESULT.
  4363.  
  4364.     INPUTS
  4365.         TITLE/K - window title for directory requester. Defaults to
  4366.                   'Select directory'.
  4367.         PATH/K  - path to open file requester in. Defaults to current
  4368.                   directory.
  4369.  
  4370.     RETURN CODE
  4371.         0 (RC_OK)   - user selected a path. The path is returned in
  4372.                       RESULT.
  4373.         5 (RC_WARN) - user cancelled the directory requester.
  4374.  
  4375.     RESULT
  4376.         The selected path.
  4377.  
  4378.     BUGS
  4379.         None known.
  4380.  
  4381.     SEE ALSO
  4382.         RequestFile
  4383. Reflex/RequestResponse                              Reflex/RequestResponse
  4384.  
  4385.     NAME
  4386.         RequestResponse  --  give user a choice
  4387.  
  4388.     SYNOPSIS
  4389.         RESULT = RequestResponse TITLE/K,PROMPT/A,DEFAULT/N/K,GADGETS
  4390.  
  4391.     FUNCTION
  4392.         This function will open a requester an give the user the choice
  4393.         of one or more possibilities.
  4394.  
  4395.         You can specify a window title for the requester, naturally the
  4396.         text to display in the requester, and the gadgets for the choices
  4397.         the user can make.
  4398.  
  4399.         The result of the user's choice is returned in RESULT.
  4400.  
  4401.     INPUTS
  4402.         TITLE/K     - window title for requester. Defaults to 'Reflex
  4403.                       message'.
  4404.         PROMPT/A    - text to display in requester.
  4405.         DEFAULT/N/K - default gadget. Number of gadget that will have have
  4406.                       return as shortcut key. The rightmost gadget has got
  4407.                       the number zero, the other gadgets are numbered from
  4408.                       one starting from the left going to the right.
  4409.                       Defaults to 0.
  4410.         GADGETS     - text for gadgets. Gadgets are separated with a pipe
  4411.                       ('|') and keyboard shortcuts are specified by
  4412.                       putting a underscore ('_') in front of the character.
  4413.                       Defaults to '_Ok|_Cancel'.
  4414.  
  4415.     RETURN CODE
  4416.         0 (RC_OK)   - requester was opened and the user made a choice. The
  4417.                       selection is availble in RESULT.
  4418.         5 (RC_WARN) - failed opening requester.
  4419.  
  4420.     RESULT
  4421.         The user selection:
  4422.  
  4423.         In a one gadget requester zero (0) is returned.
  4424.  
  4425.         In a requester with two or more gadgets the gadget to the right
  4426.         has number zero (0), and the other gadgets are numbered from the
  4427.         left to the right from one (1) and up. I.e. in a four gadget
  4428.         requester the gadgets are numbered 1 2 3 0; in a two gadget
  4429.         requester the gadgets are numbered 1 0. It is the gadget number
  4430.         that is returned in RESULT.
  4431.  
  4432.     BUGS
  4433.         None known.
  4434.  
  4435.     SEE ALSO
  4436.         RequestNotify
  4437. Reflex/RequestStatus                                  Reflex/RequestStatus
  4438.  
  4439.     NAME
  4440.         RequestStatus  --  request user for a status (flavour)
  4441.  
  4442.     SYNOPSIS
  4443.         RESULT = RequestStatus STATUS,TITLE/K,TEXT/K
  4444.  
  4445.     FUNCTION
  4446.         This command will bring forth the Status requester for the user to
  4447.         select a status (flavour), i.e. Normal, Crash, Hold or Direct.
  4448.  
  4449.         Default the Status requester will open with a Normal flavour, but
  4450.         specifying another optional flavour for the Status requester to
  4451.         open with is possible.
  4452.  
  4453.         The window title of the requester and a short text to be displayed
  4454.         above the cycle gadget can be specified.
  4455.  
  4456.         The selected status is returned in RESULT.
  4457.  
  4458.     INPUTS
  4459.         STATUS  - optional flavour ('Normal', 'Crash', 'Hold' or 'Direct')
  4460.                   for the Status requester to open with.
  4461.         TITLE/K - window title. Defaults to 'Reflex message'.
  4462.         TEXT/K  - short one-line text to be displayed above the cycle
  4463.                   gadget. Defaults to 'Select status'.
  4464.  
  4465.     RETURN CODE
  4466.         The user selected status (flavour):
  4467.  
  4468.             "1" - Normal (flavour is normal)
  4469.             "2" - Crash  (flavour is crash)
  4470.             "3" - Hold   (flavour is hold)
  4471.             "4" - Direct (flavour is direct)
  4472.  
  4473.     RESULT
  4474.         0 (RC_OK)     - user selected a flavour in the Status requester.
  4475.                         The selected status (flavour) is available in
  4476.                         RESULT.
  4477.         5 (RC_WARN)   - user cancelled the Status requester.
  4478.         10 (RC_ERROR) - (only if an open flavour is specified) the
  4479.                         specified invalid. Ought to be either 'Normal',
  4480.                         'Crash', 'Hold' or 'Direct'.
  4481.  
  4482.     BUGS
  4483.         None known.
  4484.  
  4485.     SEE ALSO
  4486.         ChangeEntryStatus, GetEntryStatus, SetEntryStatus
  4487. Reflex/Rescan                                                Reflex/Rescan
  4488.  
  4489.     NAME
  4490.         Rescan  --  rescan outbound directory
  4491.  
  4492.     SYNOPSIS
  4493.         Rescan
  4494.  
  4495.     FUNCTION
  4496.         This command scans the outbound directory. A maintenance will be
  4497.         performed after the rescan if your settings in the Deletion
  4498.         configuration window instructs Reflex to do so.
  4499.  
  4500.     INPUTS
  4501.         None.
  4502.  
  4503.     RETURN CODE
  4504.         0 (RC_OK) - is currently always returned.
  4505.  
  4506.     RESULT
  4507.         None.
  4508.  
  4509.     BUGS
  4510.         Currently Reflex occasionally fails in rescanning the outbound
  4511.         directory. This is caused because Reflex currently doesn't handle
  4512.         busy files in the outbound directory correctly. The command ought
  4513.         to return RC_ERROR (10) when it fails - but doesn't.
  4514.  
  4515.     SEE ALSO
  4516.         Maintenance
  4517. Reflex/SaveSettings                                    Reflex/SaveSettings
  4518.  
  4519.     NAME
  4520.         SaveSettings  --  save settings
  4521.  
  4522.     SYNOPSIS
  4523.         SaveSettings
  4524.  
  4525.     FUNCTION
  4526.         This command will save the settings.
  4527.  
  4528.     INPUTS
  4529.         None.
  4530.  
  4531.     RETURN CODE
  4532.         0 (RC_OK) - is always returned.
  4533.  
  4534.     RESULT
  4535.         None.
  4536.  
  4537.     BUGS
  4538.         This command ought to return an error code if it didn't save the
  4539.         settings correctly. Unfortunately this isn't possible at the
  4540.         moment.
  4541.  
  4542.     SEE ALSO
  4543.         IsCfgChanged
  4544. Reflex/SetEntryAddress                              Reflex/SetEntryAddress
  4545.  
  4546.     NAME
  4547.         SetEntryAddress  --  change address of current entry
  4548.  
  4549.     SYNOPSIS
  4550.         SetEntryAddress ADDRESS/A
  4551.  
  4552.     FUNCTION
  4553.         This command will change the addres of the current entry.
  4554.         Naturally you can only change status for entries already with a
  4555.         address.
  4556.  
  4557.         You can't change the address of a request at you own system.
  4558.  
  4559.     INPUTS
  4560.         ADDRESS/A - address to change to. Must be a valid Fido address.
  4561.  
  4562.     RETURN CODE
  4563.         0 (RC_OK)     - address was indeed changed.
  4564.         5 (RC_WARN)   - for some reason Reflex didn't succeed in changing
  4565.                         the address..
  4566.         10 (RC_ERROR) - if the specified Fido address is invalid.
  4567.         10 (RC_ERROR) - if Reflex can't change address of the current
  4568.                         entry because entry is either orphan or empty
  4569.                         file.
  4570.  
  4571.     RESULT
  4572.         None.
  4573.  
  4574.     BUGS
  4575.         None known.
  4576.  
  4577.     SEE ALSO
  4578.         ChangeEntryAddress, GetEntryAddress, RequestAddress
  4579. Reflex/SetEntryStatus                                Reflex/SetEntryStatus
  4580.  
  4581.     NAME
  4582.         SetEntryStatus  --  change status of current entry
  4583.  
  4584.     SYNOPSIS
  4585.         SetEntryStatus STATUS/A
  4586.  
  4587.     FUNCTION
  4588.         This command will change the status (flavour) of the current
  4589.         entry. Naturally you can only change status for entries with a
  4590.         Normal, Crash, Hold or Direct flavour.
  4591.  
  4592.         You can also changes requests at you system to normal flow file
  4593.         entries using this command.
  4594.  
  4595.     INPUTS
  4596.         STATUS/A - flavour to change to. 'Normal', 'Crash', 'Hold' or
  4597.                    'Direct'.
  4598.  
  4599.     RETURN CODE
  4600.         0 (RC_OK)     - status was indeed changed.
  4601.         5 (RC_WARN)   - for some reason Reflex didn't succeed in changing
  4602.                         the status. E.g. this will happen when you attempt
  4603.                         to change the status of a file request.
  4604.         10 (RC_ERROR) - if the specified status is invalid. I ought to be
  4605.                         either 'Normal', 'Crash', 'Hold' or 'Direct'.
  4606.  
  4607.     RESULT
  4608.         None.
  4609.  
  4610.     BUGS
  4611.         None known.
  4612.  
  4613.     SEE ALSO
  4614.         ChangeEntryStatus, GetEntryStatus, RequestStatus
  4615. Reflex/ShowAbout                                          Reflex/ShowAbout
  4616.  
  4617.     NAME
  4618.         ShowAbout  --  display About requester
  4619.  
  4620.     SYNOPSIS
  4621.         ShowAbout
  4622.  
  4623.     FUNCTION
  4624.         This command displays the About requester
  4625.  
  4626.     INPUTS
  4627.         None.
  4628.  
  4629.     RETURN CODE
  4630.         0 (RC_OK) - always returned
  4631.  
  4632.     RESULT
  4633.         None.
  4634.  
  4635.     BUGS
  4636.         None known.
  4637.  
  4638.     SEE ALSO
  4639. Reflex/ShowAcknowledgement                      Reflex/ShowAcknowledgement
  4640.  
  4641.     NAME
  4642.         ShowAcknowledgement  --  display Acknowledgement requesters
  4643.  
  4644.     SYNOPSIS
  4645.         ShowAcknowledgement
  4646.  
  4647.     FUNCTION
  4648.         This command displays the Acknowledgement requesters.
  4649.  
  4650.     INPUTS
  4651.         None.
  4652.  
  4653.     RETURN CODE
  4654.         0 (RC_OK) - always returned.
  4655.  
  4656.     RESULT
  4657.         None.
  4658.  
  4659.     BUGS
  4660.         None known.
  4661.  
  4662.     SEE ALSO
  4663. Reflex/ShowGUI                                              Reflex/ShowGUI
  4664.  
  4665.     NAME
  4666.         ShowGUI  --  pop up the GUI of Reflex
  4667.  
  4668.     SYNOPSIS
  4669.         ShowGUI
  4670.  
  4671.     FUNCTION
  4672.         This command will bring the graphic user interface to the front.
  4673.         Both window and screen are brought to the front.
  4674.  
  4675.         Does your script open the GUI when it starts it should close it
  4676.         again if it was closed when the script started.
  4677.  
  4678.     INPUTS
  4679.         None.
  4680.  
  4681.     RETURN CODE
  4682.         0 (RC_OK) - is always returned.
  4683.  
  4684.     RESULT
  4685.         None.
  4686.  
  4687.     BUGS
  4688.         None known.
  4689.  
  4690.     SEE ALSO
  4691.         HideGUI, IsGUI
  4692. Reflex/ShowInfo                                            Reflex/ShowInfo
  4693.  
  4694.     NAME
  4695.         ShowInfo  --  display Info requester for current entry
  4696.  
  4697.     SYNOPSIS
  4698.         ShowInfo
  4699.  
  4700.     FUNCTION
  4701.         This command displays the Info requester with information about
  4702.         the current entry in the outbound list.
  4703.  
  4704.     INPUTS
  4705.         None.
  4706.  
  4707.     RETURN CODE
  4708.         0 (RC_OK)   - requester was opened.
  4709.         5 (RC_WARN) - outbound list is empty.
  4710.  
  4711.     RESULT
  4712.         None.
  4713.  
  4714.     BUGS
  4715.         None known.
  4716.  
  4717.     SEE ALSO
  4718. Reflex/SortOutboundList                            Reflex/SortOutboundList
  4719.  
  4720.     NAME
  4721.         SortOutboundList  --  sort outbound list
  4722.  
  4723.     SYNOPSIS
  4724.         SortOutboundList
  4725.  
  4726.     FUNCTION
  4727.         This command sorts the outbound list according to Fido addresses.
  4728.  
  4729.         It is worth noticing that there outbound list pointer will be at
  4730.         the same entry in the outbound list after the sort as it was
  4731.         before the sort.
  4732.  
  4733.         This command currently requires traplist.library for the sort.
  4734.  
  4735.     INPUTS
  4736.         None.
  4737.  
  4738.     RETURN CODE
  4739.         0 (RC_OK)   - outbound list was sorted.
  4740.         5 (RC_WARN) - traplist.library not available.
  4741.  
  4742.     RESULT
  4743.         None.
  4744.  
  4745.     BUGS
  4746.         None known.
  4747.  
  4748.     SEE ALSO
  4749. Reflex/UnlockARexx                                      Reflex/UnlockARexx
  4750.  
  4751.     NAME
  4752.         UnlockARexx  --  release ARexx port
  4753.  
  4754.     SYNOPSIS
  4755.         UnlockARexx
  4756.  
  4757.     FUNCTION
  4758.         This command will free your ARexx ownership of Reflex. This will
  4759.         enable other ARexx scripts to access Reflex' ARexx port.
  4760.  
  4761.     INPUTS
  4762.         None.
  4763.  
  4764.     RETURN CODE
  4765.         0 (RC_OK) - always returned.
  4766.  
  4767.     RESULT
  4768.         None.
  4769.  
  4770.     BUGS
  4771.         None known.
  4772.  
  4773.     SEE ALSO
  4774.         LockARexx, LockGUI, QueryOwnership
  4775. Reflex/UnlockGUI                                          Reflex/UnlockGUI
  4776.  
  4777.     NAME
  4778.         UnlockGUI  --  enable user input
  4779.  
  4780.     SYNOPSIS
  4781.         UnlockGUI
  4782.  
  4783.     FUNCTION
  4784.         Enable user input after use of LockGUI. Usage of LockGUI must be
  4785.         matched with a call to UnlockGUI.
  4786.  
  4787.     INPUTS
  4788.         None.
  4789.  
  4790.     RETURN CODE
  4791.         0 (RC_OK) - is always returned.
  4792.  
  4793.     RESULT
  4794.         None.
  4795.  
  4796.     BUGS
  4797.         None known.
  4798.  
  4799.     SEE ALSO
  4800.         LockGUI, LockARexx
  4801. Reflex/UpdateProgress                                Reflex/UpdateProgress
  4802.  
  4803.     NAME
  4804.         UpdateProgress  --  update progress requester
  4805.  
  4806.     SYNOPSIS
  4807.         UpdateProgress PROGRESS/N/A,CURRENT/N/A
  4808.  
  4809.     FUNCTION
  4810.         This function updates an opened progress requester to a new value.
  4811.  
  4812.         You will need a progress requester identifier key when you address
  4813.         the progress requester. This key will you have obtained when you
  4814.         opened the progress requester using the OpenProgress command.
  4815.  
  4816.     INPUTS
  4817.         PROGRESS/N/A - progress requester identifier key obtained from
  4818.                        OpenProgress. Specifying a zero key obtained from
  4819.                        OpenProgress when Reflex failed opening a progress
  4820.                        requester is allowed.
  4821.         CURRENT/N/A  - the new value for which the progress requester
  4822.                        should be updated. This value ought to be between
  4823.                        zero and the value specified as MAX/N/A when you
  4824.                        opened the progress requester.
  4825.  
  4826.     RETURN CODE
  4827.         0 (RC_OK)   - if progress requester was updated.
  4828.         5 (RC_WARN) - progress requester identifier key was invalid (or
  4829.                       zero).
  4830.  
  4831.     RESULT
  4832.         None.
  4833.  
  4834.     BUGS
  4835.         None known.
  4836.  
  4837.     SEE ALSO
  4838.         CloseProgress, OpenProgress
  4839. Reflex/WriteLog                                            Reflex/WriteLog
  4840.  
  4841.     NAME
  4842.         WriteLog  --  write message to Reflex' log file
  4843.  
  4844.     SYNOPSIS
  4845.         WriteLog LOGMESSAGE/A,LEVEL/K/N
  4846.  
  4847.     FUNCTION
  4848.         This command enables ARexx programmers to write messages to
  4849.         Reflex' log file.
  4850.  
  4851.     INPUTS
  4852.         LOGMESSAGE/A - message to write to the log file.
  4853.         LEVEL/K/N    - log level. Must be 1 or greater; defaults to 1.
  4854.                        Negative values will be indented a bit more than
  4855.                        the positive value but pertain the same level.
  4856.  
  4857.     RETURN CODE
  4858.         0 (RC_OK) - is returned.
  4859.  
  4860.     RESULT
  4861.         None.
  4862.  
  4863.     BUGS
  4864.         This command ought to return an error code if no log file was
  4865.         specified in the Files configuration, and if Reflex for some
  4866.         reason was unable to write the message to the log file.
  4867.  
  4868.         LEVEL/K/N is currently not supported.
  4869.  
  4870.     SEE ALSO
  4871.         GetLogfile
  4872.